Class ImplementationGuide
- java.lang.Object
-
- org.hl7.fhir.r4.model.Base
-
- org.hl7.fhir.r4.model.BaseResource
-
- org.hl7.fhir.r4.model.Resource
-
- org.hl7.fhir.r4.model.DomainResource
-
- org.hl7.fhir.r4.model.MetadataResource
-
- org.hl7.fhir.r4.model.ImplementationGuide
-
- All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement,Serializable,org.hl7.fhir.instance.model.api.IAnyResource,org.hl7.fhir.instance.model.api.IBase,org.hl7.fhir.instance.model.api.IBaseHasExtensions,org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions,org.hl7.fhir.instance.model.api.IBaseResource,org.hl7.fhir.instance.model.api.IDomainResource
public class ImplementationGuide extends MetadataResource
A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. 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
-
Field Summary
Fields Modifier and Type Field Description static ca.uhn.fhir.rest.gclient.TokenClientParamCONTEXTFluent Client search parameter constant for contextstatic ca.uhn.fhir.rest.gclient.QuantityClientParamCONTEXT_QUANTITYFluent Client search parameter constant for context-quantitystatic ca.uhn.fhir.rest.gclient.TokenClientParamCONTEXT_TYPEFluent Client search parameter constant for context-typestatic ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.QuantityClientParam>CONTEXT_TYPE_QUANTITYFluent Client search parameter constant for context-type-quantitystatic ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam>CONTEXT_TYPE_VALUEFluent Client search parameter constant for context-type-valueprotected MarkdownTypecopyrightA copyright statement relating to the implementation guide and/or its contents.static ca.uhn.fhir.rest.gclient.DateClientParamDATEFluent Client search parameter constant for dateprotected ImplementationGuide.ImplementationGuideDefinitionComponentdefinitionThe information needed by an IG publisher tool to publish the whole implementation guide.static ca.uhn.fhir.rest.gclient.ReferenceClientParamDEPENDS_ONFluent Client search parameter constant for depends-onprotected List<ImplementationGuide.ImplementationGuideDependsOnComponent>dependsOnAnother implementation guide that this implementation depends on.static ca.uhn.fhir.rest.gclient.StringClientParamDESCRIPTIONFluent Client search parameter constant for descriptionstatic ca.uhn.fhir.rest.gclient.TokenClientParamEXPERIMENTALFluent Client search parameter constant for experimentalprotected List<Enumeration<Enumerations.FHIRVersion>>fhirVersionThe version(s) of the FHIR specification that this ImplementationGuide targets - e.g.protected List<ImplementationGuide.ImplementationGuideGlobalComponent>globalA set of profiles that all resources covered by this implementation guide must conform to.static ca.uhn.fhir.rest.gclient.ReferenceClientParamGLOBALFluent Client search parameter constant for globalstatic ca.uhn.fhir.model.api.IncludeINCLUDE_DEPENDS_ONConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_GLOBALConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_RESOURCEConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.rest.gclient.TokenClientParamJURISDICTIONFluent Client search parameter constant for jurisdictionprotected Enumeration<ImplementationGuide.SPDXLicense>licenseThe license that applies to this Implementation Guide, using an SPDX license code, or 'not-open-source'.protected ImplementationGuide.ImplementationGuideManifestComponentmanifestInformation about an assembled implementation guide, created by the publication tooling.static ca.uhn.fhir.rest.gclient.StringClientParamNAMEFluent Client search parameter constant for nameprotected IdTypepackageIdThe NPM package name for this Implementation Guide, used in the NPM package distribution, which is the primary mechanism by which FHIR based tooling manages IG dependencies.static ca.uhn.fhir.rest.gclient.StringClientParamPUBLISHERFluent Client search parameter constant for publisherstatic ca.uhn.fhir.rest.gclient.ReferenceClientParamRESOURCEFluent Client search parameter constant for resourcestatic StringSP_CONTEXTSearch parameter: contextstatic StringSP_CONTEXT_QUANTITYSearch parameter: context-quantitystatic StringSP_CONTEXT_TYPESearch parameter: context-typestatic StringSP_CONTEXT_TYPE_QUANTITYSearch parameter: context-type-quantitystatic StringSP_CONTEXT_TYPE_VALUESearch parameter: context-type-valuestatic StringSP_DATESearch parameter: datestatic StringSP_DEPENDS_ONSearch parameter: depends-onstatic StringSP_DESCRIPTIONSearch parameter: descriptionstatic StringSP_EXPERIMENTALSearch parameter: experimentalstatic StringSP_GLOBALSearch parameter: globalstatic StringSP_JURISDICTIONSearch parameter: jurisdictionstatic StringSP_NAMESearch parameter: namestatic StringSP_PUBLISHERSearch parameter: publisherstatic StringSP_RESOURCESearch parameter: resourcestatic StringSP_STATUSSearch parameter: statusstatic StringSP_TITLESearch parameter: titlestatic StringSP_URLSearch parameter: urlstatic StringSP_VERSIONSearch parameter: versionstatic ca.uhn.fhir.rest.gclient.TokenClientParamSTATUSFluent Client search parameter constant for statusstatic ca.uhn.fhir.rest.gclient.StringClientParamTITLEFluent Client search parameter constant for titlestatic ca.uhn.fhir.rest.gclient.UriClientParamURLFluent Client search parameter constant for urlstatic ca.uhn.fhir.rest.gclient.TokenClientParamVERSIONFluent Client search parameter constant for version-
Fields inherited from class org.hl7.fhir.r4.model.MetadataResource
contact, date, description, experimental, jurisdiction, name, publisher, status, title, url, useContext, version
-
Fields inherited from class org.hl7.fhir.r4.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.r4.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description ImplementationGuide()ConstructorImplementationGuide(UriType url, StringType name, Enumeration<Enumerations.PublicationStatus> status, IdType packageId)Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r4.model.MetadataResource
copyValues, present, toString
-
Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, 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.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, 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
-
-
-
-
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.
-
packageId
protected IdType packageId
The NPM package name for this Implementation Guide, used in the NPM package distribution, which is the primary mechanism by which FHIR based tooling manages IG dependencies. This value must be globally unique, and should be assigned with care.
-
license
protected Enumeration<ImplementationGuide.SPDXLicense> license
The license that applies to this Implementation Guide, using an SPDX license code, or 'not-open-source'.
-
fhirVersion
protected List<Enumeration<Enumerations.FHIRVersion>> fhirVersion
The version(s) of the FHIR specification that this ImplementationGuide targets - e.g. describes how to use. The value of this element is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 4.0.1. for this version.
-
dependsOn
protected List<ImplementationGuide.ImplementationGuideDependsOnComponent> dependsOn
Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.
-
global
protected List<ImplementationGuide.ImplementationGuideGlobalComponent> global
A set of profiles that all resources covered by this implementation guide must conform to.
-
definition
protected ImplementationGuide.ImplementationGuideDefinitionComponent definition
The information needed by an IG publisher tool to publish the whole implementation guide.
-
manifest
protected ImplementationGuide.ImplementationGuideManifestComponent manifest
Information about an assembled implementation guide, created by the publication tooling.
-
SP_DATE
public static final String SP_DATE
Search parameter: dateDescription: 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 dateDescription: The implementation guide publication date
Type: date
Path: ImplementationGuide.date
-
SP_CONTEXT_TYPE_VALUE
public static final String SP_CONTEXT_TYPE_VALUE
Search parameter: context-type-valueDescription: A use context type and value assigned to the implementation guide
Type: composite
Path:
- See Also:
- Constant Field Values
-
CONTEXT_TYPE_VALUE
public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam> CONTEXT_TYPE_VALUE
Fluent Client search parameter constant for context-type-valueDescription: A use context type and value assigned to the implementation guide
Type: composite
Path:
-
SP_RESOURCE
public static final String SP_RESOURCE
Search parameter: resourceDescription: Location of the resource
Type: reference
Path: ImplementationGuide.definition.resource.reference
- See Also:
- Constant Field Values
-
RESOURCE
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam RESOURCE
Fluent Client search parameter constant for resourceDescription: Location of the resource
Type: reference
Path: ImplementationGuide.definition.resource.reference
-
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_JURISDICTION
public static final String SP_JURISDICTION
Search parameter: jurisdictionDescription: Intended jurisdiction for the implementation guide
Type: token
Path: ImplementationGuide.jurisdiction
- See Also:
- Constant Field Values
-
JURISDICTION
public static final ca.uhn.fhir.rest.gclient.TokenClientParam JURISDICTION
Fluent Client search parameter constant for jurisdictionDescription: Intended jurisdiction for the implementation guide
Type: token
Path: ImplementationGuide.jurisdiction
-
SP_DESCRIPTION
public static final String SP_DESCRIPTION
Search parameter: descriptionDescription: 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 descriptionDescription: The description of the implementation guide
Type: string
Path: ImplementationGuide.description
-
SP_CONTEXT_TYPE
public static final String SP_CONTEXT_TYPE
Search parameter: context-typeDescription: A type of use context assigned to the implementation guide
Type: token
Path: ImplementationGuide.useContext.code
- See Also:
- Constant Field Values
-
CONTEXT_TYPE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT_TYPE
Fluent Client search parameter constant for context-typeDescription: A type of use context assigned to the implementation guide
Type: token
Path: ImplementationGuide.useContext.code
-
SP_EXPERIMENTAL
public static final String SP_EXPERIMENTAL
Search parameter: experimentalDescription: 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 experimentalDescription: For testing purposes, not real usage
Type: token
Path: ImplementationGuide.experimental
-
SP_GLOBAL
public static final String SP_GLOBAL
Search parameter: globalDescription: Profile that all resources must conform to
Type: reference
Path: ImplementationGuide.global.profile
- See Also:
- Constant Field Values
-
GLOBAL
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam GLOBAL
Fluent Client search parameter constant for globalDescription: Profile that all resources must conform to
Type: reference
Path: ImplementationGuide.global.profile
-
INCLUDE_GLOBAL
public static final ca.uhn.fhir.model.api.Include INCLUDE_GLOBAL
Constant for fluent queries to be used to add include statements. Specifies the path value of "ImplementationGuide:global".
-
SP_TITLE
public static final String SP_TITLE
Search parameter: titleDescription: The human-friendly name of the implementation guide
Type: string
Path: ImplementationGuide.title
- See Also:
- Constant Field Values
-
TITLE
public static final ca.uhn.fhir.rest.gclient.StringClientParam TITLE
Fluent Client search parameter constant for titleDescription: The human-friendly name of the implementation guide
Type: string
Path: ImplementationGuide.title
-
SP_VERSION
public static final String SP_VERSION
Search parameter: versionDescription: The business version 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 versionDescription: The business version of the implementation guide
Type: token
Path: ImplementationGuide.version
-
SP_URL
public static final String SP_URL
Search parameter: urlDescription: The uri that identifies the 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 urlDescription: The uri that identifies the implementation guide
Type: uri
Path: ImplementationGuide.url
-
SP_CONTEXT_QUANTITY
public static final String SP_CONTEXT_QUANTITY
Search parameter: context-quantityDescription: A quantity- or range-valued use context assigned to the implementation guide
Type: quantity
Path: ImplementationGuide.useContext.valueQuantity, ImplementationGuide.useContext.valueRange
- See Also:
- Constant Field Values
-
CONTEXT_QUANTITY
public static final ca.uhn.fhir.rest.gclient.QuantityClientParam CONTEXT_QUANTITY
Fluent Client search parameter constant for context-quantityDescription: A quantity- or range-valued use context assigned to the implementation guide
Type: quantity
Path: ImplementationGuide.useContext.valueQuantity, ImplementationGuide.useContext.valueRange
-
SP_DEPENDS_ON
public static final String SP_DEPENDS_ON
Search parameter: depends-onDescription: Identity of the IG that this depends on
Type: reference
Path: ImplementationGuide.dependsOn.uri
- See Also:
- Constant Field Values
-
DEPENDS_ON
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DEPENDS_ON
Fluent Client search parameter constant for depends-onDescription: Identity of the IG that this depends on
Type: reference
Path: ImplementationGuide.dependsOn.uri
-
INCLUDE_DEPENDS_ON
public static final ca.uhn.fhir.model.api.Include INCLUDE_DEPENDS_ON
Constant for fluent queries to be used to add include statements. Specifies the path value of "ImplementationGuide:depends-on".
-
SP_NAME
public static final String SP_NAME
Search parameter: nameDescription: Computationally friendly 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 nameDescription: Computationally friendly name of the implementation guide
Type: string
Path: ImplementationGuide.name
-
SP_CONTEXT
public static final String SP_CONTEXT
Search parameter: contextDescription: A use context assigned to the implementation guide
Type: token
Path: ImplementationGuide.useContext.valueCodeableConcept
- See Also:
- Constant Field Values
-
CONTEXT
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT
Fluent Client search parameter constant for contextDescription: A use context assigned to the implementation guide
Type: token
Path: ImplementationGuide.useContext.valueCodeableConcept
-
SP_PUBLISHER
public static final String SP_PUBLISHER
Search parameter: publisherDescription: 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 publisherDescription: Name of the publisher of the implementation guide
Type: string
Path: ImplementationGuide.publisher
-
SP_CONTEXT_TYPE_QUANTITY
public static final String SP_CONTEXT_TYPE_QUANTITY
Search parameter: context-type-quantityDescription: A use context type and quantity- or range-based value assigned to the implementation guide
Type: composite
Path:
- See Also:
- Constant Field Values
-
CONTEXT_TYPE_QUANTITY
public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.QuantityClientParam> CONTEXT_TYPE_QUANTITY
Fluent Client search parameter constant for context-type-quantityDescription: A use context type and quantity- or range-based value assigned to the implementation guide
Type: composite
Path:
-
SP_STATUS
public static final String SP_STATUS
Search parameter: statusDescription: 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 statusDescription: 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, IdType packageId)
Constructor
-
-
Method Detail
-
getUrlElement
public UriType getUrlElement()
- Overrides:
getUrlElementin classMetadataResource- 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; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this implementation guide is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the implementation guide is stored on different servers.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
-
hasUrlElement
public boolean hasUrlElement()
- Overrides:
hasUrlElementin classMetadataResource
-
hasUrl
public boolean hasUrl()
- Overrides:
hasUrlin classMetadataResource
-
setUrlElement
public ImplementationGuide setUrlElement(UriType value)
- Overrides:
setUrlElementin classMetadataResource- 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; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this implementation guide is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the implementation guide is stored on different servers.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
-
getUrl
public String getUrl()
- Overrides:
getUrlin classMetadataResource- Returns:
- An absolute URI that is used to identify this implementation guide when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this implementation guide is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the implementation guide is stored on different servers.
-
setUrl
public ImplementationGuide setUrl(String value)
- Overrides:
setUrlin classMetadataResource- 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; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this implementation guide is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the implementation guide is stored on different servers.
-
getVersionElement
public StringType getVersionElement()
- Overrides:
getVersionElementin classMetadataResource- 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:
hasVersionElementin classMetadataResource
-
hasVersion
public boolean hasVersion()
- Overrides:
hasVersionin classMetadataResource
-
setVersionElement
public ImplementationGuide setVersionElement(StringType value)
- Overrides:
setVersionElementin classMetadataResource- 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:
getVersionin classMetadataResource- 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:
setVersionin classMetadataResource- 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:
getNameElementin classMetadataResource- 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:
hasNameElementin classMetadataResource
-
hasName
public boolean hasName()
- Overrides:
hasNamein classMetadataResource
-
setNameElement
public ImplementationGuide setNameElement(StringType value)
- Overrides:
setNameElementin classMetadataResource- 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:
getNamein classMetadataResource- 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:
setNamein classMetadataResource- 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.
-
getTitleElement
public StringType getTitleElement()
- Overrides:
getTitleElementin classMetadataResource- Returns:
MetadataResource.title(A short, descriptive, user-friendly title for the implementation guide.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
-
hasTitleElement
public boolean hasTitleElement()
- Overrides:
hasTitleElementin classMetadataResource
-
hasTitle
public boolean hasTitle()
- Overrides:
hasTitlein classMetadataResource
-
setTitleElement
public ImplementationGuide setTitleElement(StringType value)
- Overrides:
setTitleElementin classMetadataResource- Parameters:
value-MetadataResource.title(A short, descriptive, user-friendly title for the implementation guide.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
-
getTitle
public String getTitle()
- Overrides:
getTitlein classMetadataResource- Returns:
- A short, descriptive, user-friendly title for the implementation guide.
-
setTitle
public ImplementationGuide setTitle(String value)
- Overrides:
setTitlein classMetadataResource- Parameters:
value- A short, descriptive, user-friendly title for the implementation guide.
-
getStatusElement
public Enumeration<Enumerations.PublicationStatus> getStatusElement()
- Overrides:
getStatusElementin classMetadataResource- 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:
hasStatusElementin classMetadataResource
-
hasStatus
public boolean hasStatus()
- Overrides:
hasStatusin classMetadataResource
-
setStatusElement
public ImplementationGuide setStatusElement(Enumeration<Enumerations.PublicationStatus> value)
- Overrides:
setStatusElementin classMetadataResource- 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:
getStatusin classMetadataResource- Returns:
- The status of this implementation guide. Enables tracking the life-cycle of the content.
-
setStatus
public ImplementationGuide setStatus(Enumerations.PublicationStatus value)
- Overrides:
setStatusin classMetadataResource- Parameters:
value- The status of this implementation guide. Enables tracking the life-cycle of the content.
-
getExperimentalElement
public BooleanType getExperimentalElement()
- Overrides:
getExperimentalElementin classMetadataResource- 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:
hasExperimentalElementin classMetadataResource
-
hasExperimental
public boolean hasExperimental()
- Overrides:
hasExperimentalin classMetadataResource
-
setExperimentalElement
public ImplementationGuide setExperimentalElement(BooleanType value)
- Overrides:
setExperimentalElementin classMetadataResource- 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:
getExperimentalin classMetadataResource- 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:
setExperimentalin classMetadataResource- 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:
getDateElementin classMetadataResource- Returns:
MetadataResource.date(The date (and optionally time) when the implementation guide was published. The date must change 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:
hasDateElementin classMetadataResource
-
hasDate
public boolean hasDate()
- Overrides:
hasDatein classMetadataResource
-
setDateElement
public ImplementationGuide setDateElement(DateTimeType value)
- Overrides:
setDateElementin classMetadataResource- Parameters:
value-MetadataResource.date(The date (and optionally time) when the implementation guide was published. The date must change 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:
getDatein classMetadataResource- Returns:
- The date (and optionally time) when the implementation guide was published. The date must change 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:
setDatein classMetadataResource- Parameters:
value- The date (and optionally time) when the implementation guide was published. The date must change 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:
getPublisherElementin classMetadataResource- Returns:
MetadataResource.publisher(The name of the organization or individual 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:
hasPublisherElementin classMetadataResource
-
hasPublisher
public boolean hasPublisher()
- Overrides:
hasPublisherin classMetadataResource
-
setPublisherElement
public ImplementationGuide setPublisherElement(StringType value)
- Overrides:
setPublisherElementin classMetadataResource- Parameters:
value-MetadataResource.publisher(The name of the organization or individual 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:
getPublisherin classMetadataResource- Returns:
- The name of the organization or individual that published the implementation guide.
-
setPublisher
public ImplementationGuide setPublisher(String value)
- Overrides:
setPublisherin classMetadataResource- Parameters:
value- The name of the organization or individual that published the implementation guide.
-
getContact
public List<ContactDetail> getContact()
- Overrides:
getContactin classMetadataResource- Returns:
MetadataResource.contact(Contact details to assist a user in finding and communicating with the publisher.)
-
setContact
public ImplementationGuide setContact(List<ContactDetail> theContact)
- Overrides:
setContactin classMetadataResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasContact
public boolean hasContact()
- Overrides:
hasContactin classMetadataResource
-
addContact
public ContactDetail addContact()
- Overrides:
addContactin classMetadataResource
-
addContact
public ImplementationGuide addContact(ContactDetail t)
- Overrides:
addContactin classMetadataResource
-
getContactFirstRep
public ContactDetail getContactFirstRep()
- Overrides:
getContactFirstRepin classMetadataResource- Returns:
- The first repetition of repeating field
MetadataResource.contact, creating it if it does not already exist
-
getDescriptionElement
public MarkdownType getDescriptionElement()
- Overrides:
getDescriptionElementin classMetadataResource- 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:
hasDescriptionElementin classMetadataResource
-
hasDescription
public boolean hasDescription()
- Overrides:
hasDescriptionin classMetadataResource
-
setDescriptionElement
public ImplementationGuide setDescriptionElement(MarkdownType value)
- Overrides:
setDescriptionElementin classMetadataResource- 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:
getDescriptionin classMetadataResource- Returns:
- A free text natural language description of the implementation guide from a consumer's perspective.
-
setDescription
public ImplementationGuide setDescription(String value)
- Overrides:
setDescriptionin classMetadataResource- Parameters:
value- A free text natural language description of the implementation guide from a consumer's perspective.
-
getUseContext
public List<UsageContext> getUseContext()
- Overrides:
getUseContextin classMetadataResource- Returns:
MetadataResource.useContext(The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate implementation guide instances.)
-
setUseContext
public ImplementationGuide setUseContext(List<UsageContext> theUseContext)
- Overrides:
setUseContextin classMetadataResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasUseContext
public boolean hasUseContext()
- Overrides:
hasUseContextin classMetadataResource
-
addUseContext
public UsageContext addUseContext()
- Overrides:
addUseContextin classMetadataResource
-
addUseContext
public ImplementationGuide addUseContext(UsageContext t)
- Overrides:
addUseContextin classMetadataResource
-
getUseContextFirstRep
public UsageContext getUseContextFirstRep()
- Overrides:
getUseContextFirstRepin classMetadataResource- Returns:
- The first repetition of repeating field
MetadataResource.useContext, creating it if it does not already exist
-
getJurisdiction
public List<CodeableConcept> getJurisdiction()
- Overrides:
getJurisdictionin classMetadataResource- 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:
setJurisdictionin classMetadataResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasJurisdiction
public boolean hasJurisdiction()
- Overrides:
hasJurisdictionin classMetadataResource
-
addJurisdiction
public CodeableConcept addJurisdiction()
- Overrides:
addJurisdictionin classMetadataResource
-
addJurisdiction
public ImplementationGuide addJurisdiction(CodeableConcept t)
- Overrides:
addJurisdictionin classMetadataResource
-
getJurisdictionFirstRep
public CodeableConcept getJurisdictionFirstRep()
- Overrides:
getJurisdictionFirstRepin classMetadataResource- 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.
-
getPackageIdElement
public IdType getPackageIdElement()
- Returns:
packageId(The NPM package name for this Implementation Guide, used in the NPM package distribution, which is the primary mechanism by which FHIR based tooling manages IG dependencies. This value must be globally unique, and should be assigned with care.). This is the underlying object with id, value and extensions. The accessor "getPackageId" gives direct access to the value
-
hasPackageIdElement
public boolean hasPackageIdElement()
-
hasPackageId
public boolean hasPackageId()
-
setPackageIdElement
public ImplementationGuide setPackageIdElement(IdType value)
- Parameters:
value-packageId(The NPM package name for this Implementation Guide, used in the NPM package distribution, which is the primary mechanism by which FHIR based tooling manages IG dependencies. This value must be globally unique, and should be assigned with care.). This is the underlying object with id, value and extensions. The accessor "getPackageId" gives direct access to the value
-
getPackageId
public String getPackageId()
- Returns:
- The NPM package name for this Implementation Guide, used in the NPM package distribution, which is the primary mechanism by which FHIR based tooling manages IG dependencies. This value must be globally unique, and should be assigned with care.
-
setPackageId
public ImplementationGuide setPackageId(String value)
- Parameters:
value- The NPM package name for this Implementation Guide, used in the NPM package distribution, which is the primary mechanism by which FHIR based tooling manages IG dependencies. This value must be globally unique, and should be assigned with care.
-
getLicenseElement
public Enumeration<ImplementationGuide.SPDXLicense> getLicenseElement()
- Returns:
license(The license that applies to this Implementation Guide, using an SPDX license code, or 'not-open-source'.). This is the underlying object with id, value and extensions. The accessor "getLicense" gives direct access to the value
-
hasLicenseElement
public boolean hasLicenseElement()
-
hasLicense
public boolean hasLicense()
-
setLicenseElement
public ImplementationGuide setLicenseElement(Enumeration<ImplementationGuide.SPDXLicense> value)
- Parameters:
value-license(The license that applies to this Implementation Guide, using an SPDX license code, or 'not-open-source'.). This is the underlying object with id, value and extensions. The accessor "getLicense" gives direct access to the value
-
getLicense
public ImplementationGuide.SPDXLicense getLicense()
- Returns:
- The license that applies to this Implementation Guide, using an SPDX license code, or 'not-open-source'.
-
setLicense
public ImplementationGuide setLicense(ImplementationGuide.SPDXLicense value)
- Parameters:
value- The license that applies to this Implementation Guide, using an SPDX license code, or 'not-open-source'.
-
getFhirVersion
public List<Enumeration<Enumerations.FHIRVersion>> getFhirVersion()
- Returns:
fhirVersion(The version(s) of the FHIR specification that this ImplementationGuide targets - e.g. describes how to use. The value of this element is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 4.0.1. for this version.)
-
setFhirVersion
public ImplementationGuide setFhirVersion(List<Enumeration<Enumerations.FHIRVersion>> theFhirVersion)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasFhirVersion
public boolean hasFhirVersion()
-
addFhirVersionElement
public Enumeration<Enumerations.FHIRVersion> addFhirVersionElement()
- Returns:
fhirVersion(The version(s) of the FHIR specification that this ImplementationGuide targets - e.g. describes how to use. The value of this element is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 4.0.1. for this version.)
-
addFhirVersion
public ImplementationGuide addFhirVersion(Enumerations.FHIRVersion value)
- Parameters:
value-fhirVersion(The version(s) of the FHIR specification that this ImplementationGuide targets - e.g. describes how to use. The value of this element is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 4.0.1. for this version.)
-
hasFhirVersion
public boolean hasFhirVersion(Enumerations.FHIRVersion value)
- Parameters:
value-fhirVersion(The version(s) of the FHIR specification that this ImplementationGuide targets - e.g. describes how to use. The value of this element is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 4.0.1. for this version.)
-
getDependsOn
public List<ImplementationGuide.ImplementationGuideDependsOnComponent> getDependsOn()
- Returns:
dependsOn(Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.)
-
setDependsOn
public ImplementationGuide setDependsOn(List<ImplementationGuide.ImplementationGuideDependsOnComponent> theDependsOn)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasDependsOn
public boolean hasDependsOn()
-
addDependsOn
public ImplementationGuide.ImplementationGuideDependsOnComponent addDependsOn()
-
addDependsOn
public ImplementationGuide addDependsOn(ImplementationGuide.ImplementationGuideDependsOnComponent t)
-
getDependsOnFirstRep
public ImplementationGuide.ImplementationGuideDependsOnComponent getDependsOnFirstRep()
- Returns:
- The first repetition of repeating field
dependsOn, 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
thisfor 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
-
getDefinition
public ImplementationGuide.ImplementationGuideDefinitionComponent getDefinition()
- Returns:
definition(The information needed by an IG publisher tool to publish the whole implementation guide.)
-
hasDefinition
public boolean hasDefinition()
-
setDefinition
public ImplementationGuide setDefinition(ImplementationGuide.ImplementationGuideDefinitionComponent value)
- Parameters:
value-definition(The information needed by an IG publisher tool to publish the whole implementation guide.)
-
getManifest
public ImplementationGuide.ImplementationGuideManifestComponent getManifest()
- Returns:
manifest(Information about an assembled implementation guide, created by the publication tooling.)
-
hasManifest
public boolean hasManifest()
-
setManifest
public ImplementationGuide setManifest(ImplementationGuide.ImplementationGuideManifestComponent value)
- Parameters:
value-manifest(Information about an assembled implementation guide, created by the publication tooling.)
-
listChildren
protected void listChildren(List<Property> children)
- Overrides:
listChildrenin classMetadataResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makePropertyin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForPropertyin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classMetadataResource
-
copy
public ImplementationGuide copy()
- Specified by:
copyin classMetadataResource
-
copyValues
public void copyValues(ImplementationGuide dst)
-
typedCopy
protected ImplementationGuide typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeepin classMetadataResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallowin classMetadataResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classMetadataResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-