ImplementationGuide (HAPI FHIR Structures

java.lang.Object
- org.hl7.fhir.dstu3.model.Base
- - org.hl7.fhir.dstu3.model.BaseResource
  - - org.hl7.fhir.dstu3.model.Resource
    - - org.hl7.fhir.dstu3.model.DomainResource
      - org.hl7.fhir.dstu3.model.MetadataResource
        
        org.hl7.fhir.dstu3.model.ImplementationGuide

All Implemented Interfaces:

IElement, Serializable, IAnyResource, IBase, IBaseHasExtensions, IBaseHasModifierExtensions, IBaseResource, IDomainResource
```
public class ImplementationGuide
extends MetadataResource
```
A set of rules of 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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ImplementationGuide.GuideDependencyType`
`static class`	`ImplementationGuide.GuideDependencyTypeEnumFactory`
`static class`	`ImplementationGuide.GuidePageKind`
`static class`	`ImplementationGuide.GuidePageKindEnumFactory`
`static class`	`ImplementationGuide.ImplementationGuideDependencyComponent`
`static class`	`ImplementationGuide.ImplementationGuideGlobalComponent`
`static class`	`ImplementationGuide.ImplementationGuidePackageComponent`
`static class`	`ImplementationGuide.ImplementationGuidePackageResourceComponent`
`static class`	`ImplementationGuide.ImplementationGuidePageComponent`

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<UriType>`	`binary` A binary file that is included in the implementation guide when it is published.
`protected MarkdownType`	`copyright` A copyright statement relating to the implementation guide and/or its contents.
`static DateClientParam`	`DATE` Fluent Client search parameter constant for date
`protected List<ImplementationGuide.ImplementationGuideDependencyComponent>`	`dependency` Another implementation guide that this implementation depends on.
`static UriClientParam`	`DEPENDENCY` Fluent Client search parameter constant for dependency
`static StringClientParam`	`DESCRIPTION` Fluent Client search parameter constant for description
`static TokenClientParam`	`EXPERIMENTAL` Fluent Client search parameter constant for experimental
`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.
`protected List<ImplementationGuide.ImplementationGuideGlobalComponent>`	`global` A set of profiles that all resources covered by this implementation guide must conform to.
`static Include`	`INCLUDE_RESOURCE` Constant for fluent queries to be used to add include statements.
`static TokenClientParam`	`JURISDICTION` Fluent Client search parameter constant for jurisdiction
`static StringClientParam`	`NAME` Fluent Client search parameter constant for name
`protected List<ImplementationGuide.ImplementationGuidePackageComponent>`	`package_` A logical group of resources.
`protected ImplementationGuide.ImplementationGuidePageComponent`	`page` A page / section in the implementation guide.
`static StringClientParam`	`PUBLISHER` Fluent Client search parameter constant for publisher
`static ReferenceClientParam`	`RESOURCE` Fluent Client search parameter constant for resource
`static String`	`SP_DATE` Search parameter: date
`static String`	`SP_DEPENDENCY` Search parameter: dependency
`static String`	`SP_DESCRIPTION` Search parameter: description
`static String`	`SP_EXPERIMENTAL` Search parameter: experimental
`static String`	`SP_JURISDICTION` Search parameter: jurisdiction
`static String`	`SP_NAME` Search parameter: name
`static String`	`SP_PUBLISHER` Search parameter: publisher
`static String`	`SP_RESOURCE` Search parameter: resource
`static String`	`SP_STATUS` Search parameter: status
`static String`	`SP_URL` Search parameter: url
`static String`	`SP_VERSION` Search parameter: version
`static TokenClientParam`	`STATUS` Fluent Client search parameter constant for status
`static UriClientParam`	`URL` Fluent Client search parameter constant for url
`static TokenClientParam`	`VERSION` Fluent Client search parameter constant for version

Fields inherited from class org.hl7.fhir.dstu3.model.MetadataResource
contact, date, description, experimental, jurisdiction, name, publisher, status, title, url, useContext, version

Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource
contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.dstu3.model.Resource
id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, SP_RES_ID, SP_RES_LANGUAGE

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors
Constructor and Description
`ImplementationGuide()` Constructor
`ImplementationGuide(UriType url, StringType name, Enumeration<Enumerations.PublicationStatus> status)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ImplementationGuide`	`addBinary(String value)`
`UriType`	`addBinaryElement()`
`Base`	`addChild(String name)`
`ContactDetail`	`addContact()`
`ImplementationGuide`	`addContact(ContactDetail t)`
`ImplementationGuide.ImplementationGuideDependencyComponent`	`addDependency()`
`ImplementationGuide`	`addDependency(ImplementationGuide.ImplementationGuideDependencyComponent t)`
`ImplementationGuide.ImplementationGuideGlobalComponent`	`addGlobal()`
`ImplementationGuide`	`addGlobal(ImplementationGuide.ImplementationGuideGlobalComponent t)`
`CodeableConcept`	`addJurisdiction()`
`ImplementationGuide`	`addJurisdiction(CodeableConcept t)`
`ImplementationGuide.ImplementationGuidePackageComponent`	`addPackage()`
`ImplementationGuide`	`addPackage(ImplementationGuide.ImplementationGuidePackageComponent t)`
`UsageContext`	`addUseContext()`
`ImplementationGuide`	`addUseContext(UsageContext t)`
`ImplementationGuide`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`String`	`fhirType()`
`List<UriType>`	`getBinary()`
`List<ContactDetail>`	`getContact()`
`ContactDetail`	`getContactFirstRep()`
`String`	`getCopyright()`
`MarkdownType`	`getCopyrightElement()`
`Date`	`getDate()`
`DateTimeType`	`getDateElement()`
`List<ImplementationGuide.ImplementationGuideDependencyComponent>`	`getDependency()`
`ImplementationGuide.ImplementationGuideDependencyComponent`	`getDependencyFirstRep()`
`String`	`getDescription()`
`MarkdownType`	`getDescriptionElement()`
`boolean`	`getExperimental()`
`BooleanType`	`getExperimentalElement()`
`String`	`getFhirVersion()`
`IdType`	`getFhirVersionElement()`
`List<ImplementationGuide.ImplementationGuideGlobalComponent>`	`getGlobal()`
`ImplementationGuide.ImplementationGuideGlobalComponent`	`getGlobalFirstRep()`
`List<CodeableConcept>`	`getJurisdiction()`
`CodeableConcept`	`getJurisdictionFirstRep()`
`String`	`getName()`
`StringType`	`getNameElement()`
`List<ImplementationGuide.ImplementationGuidePackageComponent>`	`getPackage()`
`ImplementationGuide.ImplementationGuidePackageComponent`	`getPackageFirstRep()`
`ImplementationGuide.ImplementationGuidePageComponent`	`getPage()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`String`	`getPublisher()`
`StringType`	`getPublisherElement()`
`ResourceType`	`getResourceType()`
`Enumerations.PublicationStatus`	`getStatus()`
`Enumeration<Enumerations.PublicationStatus>`	`getStatusElement()`
`String[]`	`getTypesForProperty(int hash, String name)`
`String`	`getUrl()`
`UriType`	`getUrlElement()`
`List<UsageContext>`	`getUseContext()`
`UsageContext`	`getUseContextFirstRep()`
`String`	`getVersion()`
`StringType`	`getVersionElement()`
`boolean`	`hasBinary()`
`boolean`	`hasBinary(String value)`
`boolean`	`hasContact()`
`boolean`	`hasCopyright()`
`boolean`	`hasCopyrightElement()`
`boolean`	`hasDate()`
`boolean`	`hasDateElement()`
`boolean`	`hasDependency()`
`boolean`	`hasDescription()`
`boolean`	`hasDescriptionElement()`
`boolean`	`hasExperimental()`
`boolean`	`hasExperimentalElement()`
`boolean`	`hasFhirVersion()`
`boolean`	`hasFhirVersionElement()`
`boolean`	`hasGlobal()`
`boolean`	`hasJurisdiction()`
`boolean`	`hasName()`
`boolean`	`hasNameElement()`
`boolean`	`hasPackage()`
`boolean`	`hasPage()`
`boolean`	`hasPublisher()`
`boolean`	`hasPublisherElement()`
`boolean`	`hasStatus()`
`boolean`	`hasStatusElement()`
`boolean`	`hasUrl()`
`boolean`	`hasUrlElement()`
`boolean`	`hasUseContext()`
`boolean`	`hasVersion()`
`boolean`	`hasVersionElement()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> childrenList)`
`Base`	`makeProperty(int hash, String name)`
`ImplementationGuide`	`setBinary(List<UriType> theBinary)`
`ImplementationGuide`	`setContact(List<ContactDetail> theContact)`
`ImplementationGuide`	`setCopyright(String value)`
`ImplementationGuide`	`setCopyrightElement(MarkdownType value)`
`ImplementationGuide`	`setDate(Date value)`
`ImplementationGuide`	`setDateElement(DateTimeType value)`
`ImplementationGuide`	`setDependency(List<ImplementationGuide.ImplementationGuideDependencyComponent> theDependency)`
`ImplementationGuide`	`setDescription(String value)`
`ImplementationGuide`	`setDescriptionElement(MarkdownType value)`
`ImplementationGuide`	`setExperimental(boolean value)`
`ImplementationGuide`	`setExperimentalElement(BooleanType value)`
`ImplementationGuide`	`setFhirVersion(String value)`
`ImplementationGuide`	`setFhirVersionElement(IdType value)`
`ImplementationGuide`	`setGlobal(List<ImplementationGuide.ImplementationGuideGlobalComponent> theGlobal)`
`ImplementationGuide`	`setJurisdiction(List<CodeableConcept> theJurisdiction)`
`ImplementationGuide`	`setName(String value)`
`ImplementationGuide`	`setNameElement(StringType value)`
`ImplementationGuide`	`setPackage(List<ImplementationGuide.ImplementationGuidePackageComponent> thePackage)`
`ImplementationGuide`	`setPage(ImplementationGuide.ImplementationGuidePageComponent value)`
`Base`	`setProperty(int hash, String name, Base value)`
`Base`	`setProperty(String name, Base value)`
`ImplementationGuide`	`setPublisher(String value)`
`ImplementationGuide`	`setPublisherElement(StringType value)`
`ImplementationGuide`	`setStatus(Enumerations.PublicationStatus value)`
`ImplementationGuide`	`setStatusElement(Enumeration<Enumerations.PublicationStatus> value)`
`ImplementationGuide`	`setUrl(String value)`
`ImplementationGuide`	`setUrlElement(UriType value)`
`ImplementationGuide`	`setUseContext(List<UsageContext> theUseContext)`
`ImplementationGuide`	`setVersion(String value)`
`ImplementationGuide`	`setVersionElement(StringType value)`
`protected ImplementationGuide`	`typedCopy()`

Methods inherited from class org.hl7.fhir.dstu3.model.MetadataResource
copyValues, getTitle, getTitleElement, hasTitle, hasTitleElement, setTitle, setTitleElement, toString

Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

Methods inherited from class org.hl7.fhir.dstu3.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.dstu3.model.BaseResource
getStructureFhirVersionEnum, isResource, setId

Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, setId

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

- Field Detail
  - copyright
```
protected MarkdownType 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 implementation guide.
  - 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 3.0.1 for this version.
  - dependency
```
protected List<ImplementationGuide.ImplementationGuideDependencyComponent> dependency
```
    Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.
  - package_
```
protected List<ImplementationGuide.ImplementationGuidePackageComponent> package_
```
    A logical group of resources. Logical groups can be used when building pages.
  - global
```
protected List<ImplementationGuide.ImplementationGuideGlobalComponent> global
```
    A set of profiles that all resources covered by this implementation guide must conform to.
  - binary
```
protected List<UriType> binary
```
    A binary file that is included in the implementation guide when it is published.
  - page
```
protected ImplementationGuide.ImplementationGuidePageComponent page
```
    A page / section in the implementation guide. The root page is the implementation guide home page.
  - 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 DateClientParam DATE
```
    Fluent Client search parameter constant for date
    Description: The implementation guide publication date
    Type: date
    Path: ImplementationGuide.date
  - 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 UriClientParam DEPENDENCY
```
    Fluent Client search parameter constant for dependency
    Description: Where to find dependency
    Type: uri
    Path: ImplementationGuide.dependency.uri
  - 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 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 Include INCLUDE_RESOURCE
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "ImplementationGuide:resource".
  - SP_JURISDICTION
```
public static final String SP_JURISDICTION
```
    Search parameter: jurisdiction
    Description: Intended jurisdiction for the implementation guide
    Type: token
    Path: ImplementationGuide.jurisdiction
    
    See Also:
    
    Constant Field Values
  - JURISDICTION
```
public static final TokenClientParam JURISDICTION
```
    Fluent Client search parameter constant for jurisdiction
    Description: Intended jurisdiction for the implementation guide
    Type: token
    Path: ImplementationGuide.jurisdiction
  - SP_NAME
```
public static final String SP_NAME
```
    Search parameter: name
    Description: Computationally friendly name of the implementation guide
    Type: string
    Path: ImplementationGuide.name
    
    See Also:
    
    Constant Field Values
  - NAME
```
public static final StringClientParam NAME
```
    Fluent Client search parameter constant for name
    Description: Computationally friendly name of the implementation guide
    Type: string
    Path: ImplementationGuide.name
  - SP_DESCRIPTION
```
public static final String SP_DESCRIPTION
```
    Search parameter: description
    Description: The description of the implementation guide
    Type: string
    Path: ImplementationGuide.description
    
    See Also:
    
    Constant Field Values
  - DESCRIPTION
```
public static final StringClientParam DESCRIPTION
```
    Fluent Client search parameter constant for description
    Description: The description of the implementation guide
    Type: string
    Path: ImplementationGuide.description
  - 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 StringClientParam PUBLISHER
```
    Fluent Client search parameter constant for publisher
    Description: Name of the publisher of the implementation guide
    Type: string
    Path: ImplementationGuide.publisher
  - SP_EXPERIMENTAL
```
public static final String SP_EXPERIMENTAL
```
    Search parameter: experimental
    Description: For testing purposes, not real usage
    Type: token
    Path: ImplementationGuide.experimental
    
    See Also:
    
    Constant Field Values
  - EXPERIMENTAL
```
public static final TokenClientParam EXPERIMENTAL
```
    Fluent Client search parameter constant for experimental
    Description: For testing purposes, not real usage
    Type: token
    Path: ImplementationGuide.experimental
  - SP_VERSION
```
public static final String SP_VERSION
```
    Search parameter: version
    Description: The business version of the implementation guide
    Type: token
    Path: ImplementationGuide.version
    
    See Also:
    
    Constant Field Values
  - VERSION
```
public static final TokenClientParam VERSION
```
    Fluent Client search parameter constant for version
    Description: The business version of the implementation guide
    Type: token
    Path: ImplementationGuide.version
  - SP_URL
```
public static final String SP_URL
```
    Search parameter: url
    Description: The uri that identifies the implementation guide
    Type: uri
    Path: ImplementationGuide.url
    
    See Also:
    
    Constant Field Values
  - URL
```
public static final UriClientParam URL
```
    Fluent Client search parameter constant for url
    Description: The uri that identifies the implementation guide
    Type: uri
    Path: ImplementationGuide.url
  - 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 TokenClientParam STATUS
```
    Fluent Client search parameter constant for status
    Description: The current status of the implementation guide
    Type: token
    Path: ImplementationGuide.status
- Constructor Detail
  - ImplementationGuide
```
public ImplementationGuide()
```
    Constructor
  - ImplementationGuide
```
public ImplementationGuide(UriType url,
                           StringType name,
                           Enumeration<Enumerations.PublicationStatus> status)
```
    Constructor
- Method Detail
  - getUrlElement
```
public UriType getUrlElement()
```
    Overrides:
    
    getUrlElement in class MetadataResource
    
    Returns:
    
    MetadataResource.url (An absolute URI 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. The URL SHOULD include the major version of the implementation guide. 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
  - hasUrlElement
```
public boolean hasUrlElement()
```
    Overrides:
    
    hasUrlElement in class MetadataResource
  - hasUrl
```
public boolean hasUrl()
```
    Overrides:
    
    hasUrl in class MetadataResource
  - setUrlElement
```
public ImplementationGuide setUrlElement(UriType value)
```
    Overrides:
    
    setUrlElement in class MetadataResource
    
    Parameters:
    
    value - MetadataResource.url (An absolute URI 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. The URL SHOULD include the major version of the implementation guide. 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
  - getUrl
```
public String getUrl()
```
    Overrides:
    
    getUrl in class MetadataResource
    
    Returns:
    
    An absolute URI 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. The URL SHOULD include the major version of the implementation guide. For more information see [Technical and Business Versions](resource.html#versions).
  - setUrl
```
public ImplementationGuide setUrl(String value)
```
    Overrides:
    
    setUrl in class MetadataResource
    
    Parameters:
    
    value - An absolute URI 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. The URL SHOULD include the major version of the implementation guide. For more information see [Technical and Business Versions](resource.html#versions).
  - getVersionElement
```
public StringType getVersionElement()
```
    Overrides:
    
    getVersionElement in class MetadataResource
    
    Returns:
    
    MetadataResource.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 and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
  - hasVersionElement
```
public boolean hasVersionElement()
```
    Overrides:
    
    hasVersionElement in class MetadataResource
  - hasVersion
```
public boolean hasVersion()
```
    Overrides:
    
    hasVersion in class MetadataResource
  - setVersionElement
```
public ImplementationGuide setVersionElement(StringType value)
```
    Overrides:
    
    setVersionElement in class MetadataResource
    
    Parameters:
    
    value - MetadataResource.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 and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
  - getVersion
```
public String getVersion()
```
    Overrides:
    
    getVersion in class MetadataResource
    
    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 and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
  - setVersion
```
public ImplementationGuide setVersion(String value)
```
    Overrides:
    
    setVersion in class MetadataResource
    
    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 and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
  - getNameElement
```
public StringType getNameElement()
```
    Overrides:
    
    getNameElement in class MetadataResource
    
    Returns:
    
    MetadataResource.name (A natural language name identifying the implementation guide. This name should be usable as an identifier for the module by machine processing applications such as code generation.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
  - hasNameElement
```
public boolean hasNameElement()
```
    Overrides:
    
    hasNameElement in class MetadataResource
  - hasName
```
public boolean hasName()
```
    Overrides:
    
    hasName in class MetadataResource
  - setNameElement
```
public ImplementationGuide setNameElement(StringType value)
```
    Overrides:
    
    setNameElement in class MetadataResource
    
    Parameters:
    
    value - MetadataResource.name (A natural language name identifying the implementation guide. This name should be usable as an identifier for the module by machine processing applications such as code generation.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
  - getName
```
public String getName()
```
    Overrides:
    
    getName in class MetadataResource
    
    Returns:
    
    A natural language name identifying the implementation guide. This name should be usable as an identifier for the module by machine processing applications such as code generation.
  - setName
```
public ImplementationGuide setName(String value)
```
    Overrides:
    
    setName in class MetadataResource
    
    Parameters:
    
    value - A natural language name identifying the implementation guide. This name should be usable as an identifier for the module by machine processing applications such as code generation.
  - getStatusElement
```
public Enumeration<Enumerations.PublicationStatus> getStatusElement()
```
    Overrides:
    
    getStatusElement in class MetadataResource
    
    Returns:
    
    MetadataResource.status (The status of this implementation guide. Enables tracking the life-cycle of the content.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
  - hasStatusElement
```
public boolean hasStatusElement()
```
    Overrides:
    
    hasStatusElement in class MetadataResource
  - hasStatus
```
public boolean hasStatus()
```
    Overrides:
    
    hasStatus in class MetadataResource
  - setStatusElement
```
public ImplementationGuide setStatusElement(Enumeration<Enumerations.PublicationStatus> value)
```
    Overrides:
    
    setStatusElement in class MetadataResource
    
    Parameters:
    
    value - MetadataResource.status (The status of this implementation guide. Enables tracking the life-cycle of the content.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
  - getStatus
```
public Enumerations.PublicationStatus getStatus()
```
    Overrides:
    
    getStatus in class MetadataResource
    
    Returns:
    
    The status of this implementation guide. Enables tracking the life-cycle of the content.
  - setStatus
```
public ImplementationGuide setStatus(Enumerations.PublicationStatus value)
```
    Overrides:
    
    setStatus in class MetadataResource
    
    Parameters:
    
    value - The status of this implementation guide. Enables tracking the life-cycle of the content.
  - getExperimentalElement
```
public BooleanType getExperimentalElement()
```
    Overrides:
    
    getExperimentalElement in class MetadataResource
    
    Returns:
    
    MetadataResource.experimental (A boolean value to indicate that this implementation guide is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value
  - hasExperimentalElement
```
public boolean hasExperimentalElement()
```
    Overrides:
    
    hasExperimentalElement in class MetadataResource
  - hasExperimental
```
public boolean hasExperimental()
```
    Overrides:
    
    hasExperimental in class MetadataResource
  - setExperimentalElement
```
public ImplementationGuide setExperimentalElement(BooleanType value)
```
    Overrides:
    
    setExperimentalElement in class MetadataResource
    
    Parameters:
    
    value - MetadataResource.experimental (A boolean value to indicate that this implementation guide is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value
  - getExperimental
```
public boolean getExperimental()
```
    Overrides:
    
    getExperimental in class MetadataResource
    
    Returns:
    
    A boolean value to indicate that this implementation guide is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
  - setExperimental
```
public ImplementationGuide setExperimental(boolean value)
```
    Overrides:
    
    setExperimental in class MetadataResource
    
    Parameters:
    
    value - A boolean value to indicate that this implementation guide is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
  - getDateElement
```
public DateTimeType getDateElement()
```
    Overrides:
    
    getDateElement in class MetadataResource
    
    Returns:
    
    MetadataResource.date (The date (and optionally time) when the implementation guide was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the 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()
```
    Overrides:
    
    hasDateElement in class MetadataResource
  - hasDate
```
public boolean hasDate()
```
    Overrides:
    
    hasDate in class MetadataResource
  - setDateElement
```
public ImplementationGuide setDateElement(DateTimeType value)
```
    Overrides:
    
    setDateElement in class MetadataResource
    
    Parameters:
    
    value - MetadataResource.date (The date (and optionally time) when the implementation guide was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the 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()
```
    Overrides:
    
    getDate in class MetadataResource
    
    Returns:
    
    The date (and optionally time) when the implementation guide was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the implementation guide changes.
  - setDate
```
public ImplementationGuide setDate(Date value)
```
    Overrides:
    
    setDate in class MetadataResource
    
    Parameters:
    
    value - The date (and optionally time) when the implementation guide was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the implementation guide changes.
  - getPublisherElement
```
public StringType getPublisherElement()
```
    Overrides:
    
    getPublisherElement in class MetadataResource
    
    Returns:
    
    MetadataResource.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()
```
    Overrides:
    
    hasPublisherElement in class MetadataResource
  - hasPublisher
```
public boolean hasPublisher()
```
    Overrides:
    
    hasPublisher in class MetadataResource
  - setPublisherElement
```
public ImplementationGuide setPublisherElement(StringType value)
```
    Overrides:
    
    setPublisherElement in class MetadataResource
    
    Parameters:
    
    value - MetadataResource.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()
```
    Overrides:
    
    getPublisher in class MetadataResource
    
    Returns:
    
    The name of the individual or organization that published the implementation guide.
  - setPublisher
```
public ImplementationGuide setPublisher(String value)
```
    Overrides:
    
    setPublisher in class MetadataResource
    
    Parameters:
    
    value - The name of the individual or organization that published the implementation guide.
  - getContact
```
public List<ContactDetail> getContact()
```
    Overrides:
    
    getContact in class MetadataResource
    
    Returns:
    
    MetadataResource.contact (Contact details to assist a user in finding and communicating with the publisher.)
  - setContact
```
public ImplementationGuide setContact(List<ContactDetail> theContact)
```
    Overrides:
    
    setContact in class MetadataResource
    
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasContact
```
public boolean hasContact()
```
    Overrides:
    
    hasContact in class MetadataResource
  - addContact
```
public ContactDetail addContact()
```
    Overrides:
    
    addContact in class MetadataResource
  - addContact
```
public ImplementationGuide addContact(ContactDetail t)
```
    Overrides:
    
    addContact in class MetadataResource
  - getContactFirstRep
```
public ContactDetail getContactFirstRep()
```
    Overrides:
    
    getContactFirstRep in class MetadataResource
    
    Returns:
    
    The first repetition of repeating field MetadataResource.contact, creating it if it does not already exist
  - getDescriptionElement
```
public MarkdownType getDescriptionElement()
```
    Overrides:
    
    getDescriptionElement in class MetadataResource
    
    Returns:
    
    MetadataResource.description (A free text natural language description of the implementation guide from a consumer's perspective.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
  - hasDescriptionElement
```
public boolean hasDescriptionElement()
```
    Overrides:
    
    hasDescriptionElement in class MetadataResource
  - hasDescription
```
public boolean hasDescription()
```
    Overrides:
    
    hasDescription in class MetadataResource
  - setDescriptionElement
```
public ImplementationGuide setDescriptionElement(MarkdownType value)
```
    Overrides:
    
    setDescriptionElement in class MetadataResource
    
    Parameters:
    
    value - MetadataResource.description (A free text natural language description of the implementation guide from a consumer's perspective.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
  - getDescription
```
public String getDescription()
```
    Overrides:
    
    getDescription in class MetadataResource
    
    Returns:
    
    A free text natural language description of the implementation guide from a consumer's perspective.
  - setDescription
```
public ImplementationGuide setDescription(String value)
```
    Overrides:
    
    setDescription in class MetadataResource
    
    Parameters:
    
    value - A free text natural language description of the implementation guide from a consumer's perspective.
  - getUseContext
```
public List<UsageContext> getUseContext()
```
    Overrides:
    
    getUseContext in class MetadataResource
    
    Returns:
    
    MetadataResource.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 for appropriate implementation guide instances.)
  - setUseContext
```
public ImplementationGuide setUseContext(List<UsageContext> theUseContext)
```
    Overrides:
    
    setUseContext in class MetadataResource
    
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasUseContext
```
public boolean hasUseContext()
```
    Overrides:
    
    hasUseContext in class MetadataResource
  - addUseContext
```
public UsageContext addUseContext()
```
    Overrides:
    
    addUseContext in class MetadataResource
  - addUseContext
```
public ImplementationGuide addUseContext(UsageContext t)
```
    Overrides:
    
    addUseContext in class MetadataResource
  - getUseContextFirstRep
```
public UsageContext getUseContextFirstRep()
```
    Overrides:
    
    getUseContextFirstRep in class MetadataResource
    
    Returns:
    
    The first repetition of repeating field MetadataResource.useContext, creating it if it does not already exist
  - getJurisdiction
```
public List<CodeableConcept> getJurisdiction()
```
    Overrides:
    
    getJurisdiction in class MetadataResource
    
    Returns:
    
    MetadataResource.jurisdiction (A legal or geographic region in which the implementation guide is intended to be used.)
  - setJurisdiction
```
public ImplementationGuide setJurisdiction(List<CodeableConcept> theJurisdiction)
```
    Overrides:
    
    setJurisdiction in class MetadataResource
    
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasJurisdiction
```
public boolean hasJurisdiction()
```
    Overrides:
    
    hasJurisdiction in class MetadataResource
  - addJurisdiction
```
public CodeableConcept addJurisdiction()
```
    Overrides:
    
    addJurisdiction in class MetadataResource
  - addJurisdiction
```
public ImplementationGuide addJurisdiction(CodeableConcept t)
```
    Overrides:
    
    addJurisdiction in class MetadataResource
  - getJurisdictionFirstRep
```
public CodeableConcept getJurisdictionFirstRep()
```
    Overrides:
    
    getJurisdictionFirstRep in class MetadataResource
    
    Returns:
    
    The first repetition of repeating field MetadataResource.jurisdiction, creating it if it does not already exist
  - getCopyrightElement
```
public MarkdownType 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 implementation guide.). 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(MarkdownType 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 implementation guide.). 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 implementation guide.
  - 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 implementation guide.
  - 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 3.0.1 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 3.0.1 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 3.0.1 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 3.0.1 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.)
  - setDependency
```
public ImplementationGuide setDependency(List<ImplementationGuide.ImplementationGuideDependencyComponent> theDependency)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasDependency
```
public boolean hasDependency()
```
  - addDependency
```
public ImplementationGuide.ImplementationGuideDependencyComponent addDependency()
```
  - addDependency
```
public ImplementationGuide addDependency(ImplementationGuide.ImplementationGuideDependencyComponent t)
```
  - getDependencyFirstRep
```
public ImplementationGuide.ImplementationGuideDependencyComponent getDependencyFirstRep()
```
    Returns:
    
    The first repetition of repeating field dependency, creating it if it does not already exist
  - getPackage
```
public List<ImplementationGuide.ImplementationGuidePackageComponent> getPackage()
```
    Returns:
    
    package_ (A logical group of resources. Logical groups can be used when building pages.)
  - setPackage
```
public ImplementationGuide setPackage(List<ImplementationGuide.ImplementationGuidePackageComponent> thePackage)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasPackage
```
public boolean hasPackage()
```
  - addPackage
```
public ImplementationGuide.ImplementationGuidePackageComponent addPackage()
```
  - addPackage
```
public ImplementationGuide addPackage(ImplementationGuide.ImplementationGuidePackageComponent t)
```
  - getPackageFirstRep
```
public ImplementationGuide.ImplementationGuidePackageComponent getPackageFirstRep()
```
    Returns:
    
    The first repetition of repeating field package_, creating it if it does not already exist
  - getGlobal
```
public List<ImplementationGuide.ImplementationGuideGlobalComponent> getGlobal()
```
    Returns:
    
    global (A set of profiles that all resources covered by this implementation guide must conform to.)
  - setGlobal
```
public ImplementationGuide setGlobal(List<ImplementationGuide.ImplementationGuideGlobalComponent> theGlobal)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasGlobal
```
public boolean hasGlobal()
```
  - addGlobal
```
public ImplementationGuide.ImplementationGuideGlobalComponent addGlobal()
```
  - addGlobal
```
public ImplementationGuide addGlobal(ImplementationGuide.ImplementationGuideGlobalComponent t)
```
  - getGlobalFirstRep
```
public ImplementationGuide.ImplementationGuideGlobalComponent getGlobalFirstRep()
```
    Returns:
    
    The first repetition of repeating field global, creating it if it does not already exist
  - getBinary
```
public List<UriType> getBinary()
```
    Returns:
    
    binary (A binary file that is included in the implementation guide when it is published.)
  - setBinary
```
public ImplementationGuide setBinary(List<UriType> theBinary)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - 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 MetadataResource
  - getProperty
```
public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws FHIRException
```
    Overrides:
    
    getProperty in class MetadataResource
    
    Throws:
    
    FHIRException
  - setProperty
```
public Base setProperty(int hash,
                        String name,
                        Base value)
                 throws FHIRException
```
    Overrides:
    
    setProperty in class MetadataResource
    
    Throws:
    
    FHIRException
  - setProperty
```
public Base setProperty(String name,
                        Base value)
                 throws FHIRException
```
    Overrides:
    
    setProperty in class MetadataResource
    
    Throws:
    
    FHIRException
  - makeProperty
```
public Base makeProperty(int hash,
                         String name)
                  throws FHIRException
```
    Overrides:
    
    makeProperty in class MetadataResource
    
    Throws:
    
    FHIRException
  - getTypesForProperty
```
public String[] getTypesForProperty(int hash,
                                    String name)
                             throws FHIRException
```
    Overrides:
    
    getTypesForProperty in class MetadataResource
    
    Throws:
    
    FHIRException
  - addChild
```
public Base addChild(String name)
              throws FHIRException
```
    Overrides:
    
    addChild in class MetadataResource
    
    Throws:
    
    FHIRException
  - fhirType
```
public String fhirType()
```
    Overrides:
    
    fhirType in class MetadataResource
  - copy
```
public ImplementationGuide copy()
```
    Specified by:
    
    copy in class MetadataResource
  - typedCopy
```
protected ImplementationGuide typedCopy()
```
  - equalsDeep
```
public boolean equalsDeep(Base other)
```
    Overrides:
    
    equalsDeep in class MetadataResource
  - equalsShallow
```
public boolean equalsShallow(Base other)
```
    Overrides:
    
    equalsShallow in class MetadataResource
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IBase
    
    Overrides:
    
    isEmpty in class MetadataResource
  - getResourceType
```
public ResourceType getResourceType()
```
    Specified by:
    
    getResourceType in class Resource

Class ImplementationGuide

Nested Class Summary

Field Summary

Fields inherited from class org.hl7.fhir.dstu3.model.MetadataResource

Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource

Fields inherited from class org.hl7.fhir.dstu3.model.Resource

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.dstu3.model.MetadataResource

Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource

Methods inherited from class org.hl7.fhir.dstu3.model.Resource

Methods inherited from class org.hl7.fhir.dstu3.model.BaseResource

Methods inherited from class org.hl7.fhir.dstu3.model.Base

Methods inherited from class java.lang.Object

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

Field Detail

copyright

fhirVersion

dependency

package_

global

binary

page

SP_DATE

DATE

SP_DEPENDENCY

DEPENDENCY

SP_RESOURCE

RESOURCE

INCLUDE_RESOURCE

SP_JURISDICTION

JURISDICTION

SP_NAME

NAME

SP_DESCRIPTION

DESCRIPTION

SP_PUBLISHER

PUBLISHER

SP_EXPERIMENTAL

EXPERIMENTAL

SP_VERSION

VERSION

SP_URL

URL

SP_STATUS

STATUS

Constructor Detail

ImplementationGuide

ImplementationGuide

Method Detail

getUrlElement

hasUrlElement

hasUrl

setUrlElement

getUrl

setUrl

getVersionElement

hasVersionElement

hasVersion

setVersionElement

getVersion

setVersion

getNameElement

hasNameElement

hasName

setNameElement

getName

setName

getStatusElement

hasStatusElement

hasStatus

setStatusElement

getStatus

setStatus

getExperimentalElement

hasExperimentalElement