public class ImplementationGuide extends DomainResource
| 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.ImplementationGuideContactComponent |
static class |
ImplementationGuide.ImplementationGuideDependencyComponent |
static class |
ImplementationGuide.ImplementationGuideGlobalComponent |
static class |
ImplementationGuide.ImplementationGuidePackageComponent |
static class |
ImplementationGuide.ImplementationGuidePackageResourceComponent |
static class |
ImplementationGuide.ImplementationGuidePageComponent |
| 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 List<ImplementationGuide.ImplementationGuideContactComponent> |
contact
Contacts to assist a user in finding and communicating with the publisher.
|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
CONTEXT
Fluent Client search parameter constant for context
|
protected StringType |
copyright
A copyright statement relating to the implementation guide and/or its contents.
|
protected DateTimeType |
date
The date this version of the implementation guide was published.
|
static ca.uhn.fhir.rest.gclient.DateClientParam |
DATE
Fluent Client search parameter constant for date
|
protected List<ImplementationGuide.ImplementationGuideDependencyComponent> |
dependency
Another implementation guide that this implementation depends on.
|
static ca.uhn.fhir.rest.gclient.UriClientParam |
DEPENDENCY
Fluent Client search parameter constant for dependency
|
protected StringType |
description
A free text natural language description of the Implementation Guide and its use.
|
static ca.uhn.fhir.rest.gclient.StringClientParam |
DESCRIPTION
Fluent Client search parameter constant for description
|
protected BooleanType |
experimental
This Implementation Guide was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
|
static ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.model.api.Include |
INCLUDE_RESOURCE
Constant for fluent queries to be used to add include statements.
|
protected StringType |
name
A free text natural language name identifying the Implementation Guide.
|
static ca.uhn.fhir.rest.gclient.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.
|
protected StringType |
publisher
The name of the individual or organization that published the implementation guide.
|
static ca.uhn.fhir.rest.gclient.StringClientParam |
PUBLISHER
Fluent Client search parameter constant for publisher
|
static ca.uhn.fhir.rest.gclient.ReferenceClientParam |
RESOURCE
Fluent Client search parameter constant for resource
|
static String |
SP_CONTEXT
Search parameter: context
|
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_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
|
protected Enumeration<Enumerations.ConformanceResourceStatus> |
status
The status of the Implementation Guide.
|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
STATUS
Fluent Client search parameter constant for status
|
protected UriType |
url
An absolute URL that is used to identify this implementation guide when it is referenced in a specification, model, design or an instance.
|
static ca.uhn.fhir.rest.gclient.UriClientParam |
URL
Fluent Client search parameter constant for url
|
protected List<CodeableConcept> |
useContext
The content was developed with a focus and intent of supporting the contexts that are listed.
|
protected StringType |
version
The identifier that is used to identify this version of the Implementation Guide when it is referenced in a specification, model, design or instance.
|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
VERSION
Fluent Client search parameter constant for version
|
contained, extension, modifierExtension, textid, implicitRules, language, meta| Constructor and Description |
|---|
ImplementationGuide()
Constructor
|
ImplementationGuide(UriType url,
StringType name,
Enumeration<Enumerations.ConformanceResourceStatus> status,
ImplementationGuide.ImplementationGuidePageComponent page)
Constructor
|
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setTextcopyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMetagetStructureFhirVersionEnum, setIdcastToActionDefinition, castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToModuleMetadata, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINNclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetId, getIdElement, getLanguageElement, getUserData, setId, setUserDataprotected UriType url
protected StringType version
protected StringType name
protected Enumeration<Enumerations.ConformanceResourceStatus> status
protected BooleanType experimental
protected StringType publisher
protected List<ImplementationGuide.ImplementationGuideContactComponent> contact
protected DateTimeType date
protected StringType description
protected List<CodeableConcept> useContext
protected StringType copyright
protected IdType fhirVersion
protected List<ImplementationGuide.ImplementationGuideDependencyComponent> dependency
protected List<ImplementationGuide.ImplementationGuidePackageComponent> package_
protected List<ImplementationGuide.ImplementationGuideGlobalComponent> global
protected List<UriType> binary
protected ImplementationGuide.ImplementationGuidePageComponent page
public static final String SP_DEPENDENCY
Description: Where to find dependency
Type: uri
Path: ImplementationGuide.dependency.uri
public static final ca.uhn.fhir.rest.gclient.UriClientParam DEPENDENCY
Description: Where to find dependency
Type: uri
Path: ImplementationGuide.dependency.uri
public static final String SP_STATUS
Description: The current status of the implementation guide
Type: token
Path: ImplementationGuide.status
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
Description: The current status of the implementation guide
Type: token
Path: ImplementationGuide.status
public static final String SP_DESCRIPTION
Description: Text search in the description of the implementation guide
Type: string
Path: ImplementationGuide.description
public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION
Description: Text search in the description of the implementation guide
Type: string
Path: ImplementationGuide.description
public static final String SP_NAME
Description: Name of the implementation guide
Type: string
Path: ImplementationGuide.name
public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME
Description: Name of the implementation guide
Type: string
Path: ImplementationGuide.name
public static final String SP_RESOURCE
Description: Location of the resource
Type: reference
Path: ImplementationGuide.package.resource.source[x]
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam RESOURCE
Description: Location of the resource
Type: reference
Path: ImplementationGuide.package.resource.source[x]
public static final ca.uhn.fhir.model.api.Include INCLUDE_RESOURCE
public static final String SP_CONTEXT
Description: A use context assigned to the structure
Type: token
Path: ImplementationGuide.useContext
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT
Description: A use context assigned to the structure
Type: token
Path: ImplementationGuide.useContext
public static final String SP_EXPERIMENTAL
Description: If for testing purposes, not real usage
Type: token
Path: ImplementationGuide.experimental
public static final ca.uhn.fhir.rest.gclient.TokenClientParam EXPERIMENTAL
Description: If for testing purposes, not real usage
Type: token
Path: ImplementationGuide.experimental
public static final String SP_DATE
Description: The implementation guide publication date
Type: date
Path: ImplementationGuide.date
public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
Description: The implementation guide publication date
Type: date
Path: ImplementationGuide.date
public static final String SP_URL
Description: Absolute URL used to reference this Implementation Guide
Type: uri
Path: ImplementationGuide.url
public static final ca.uhn.fhir.rest.gclient.UriClientParam URL
Description: Absolute URL used to reference this Implementation Guide
Type: uri
Path: ImplementationGuide.url
public static final String SP_PUBLISHER
Description: Name of the publisher of the implementation guide
Type: string
Path: ImplementationGuide.publisher
public static final ca.uhn.fhir.rest.gclient.StringClientParam PUBLISHER
Description: Name of the publisher of the implementation guide
Type: string
Path: ImplementationGuide.publisher
public static final String SP_VERSION
Description: The version identifier of the implementation guide
Type: token
Path: ImplementationGuide.version
public static final ca.uhn.fhir.rest.gclient.TokenClientParam VERSION
Description: The version identifier of the implementation guide
Type: token
Path: ImplementationGuide.version
public ImplementationGuide()
public ImplementationGuide(UriType url, StringType name, Enumeration<Enumerations.ConformanceResourceStatus> status, ImplementationGuide.ImplementationGuidePageComponent page)
public UriType getUrlElement()
url (An absolute URL that is used to identify this implementation guide when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this implementation guide is (or will be) published.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the valuepublic boolean hasUrlElement()
public boolean hasUrl()
public ImplementationGuide setUrlElement(UriType value)
value - url (An absolute URL that is used to identify this implementation guide when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this implementation guide is (or will be) published.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the valuepublic String getUrl()
public ImplementationGuide setUrl(String value)
value - An absolute URL that is used to identify this implementation guide when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this implementation guide is (or will be) published.public StringType getVersionElement()
version (The identifier that is used to identify this version of the Implementation Guide when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the Implementation Guide author manually.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the valuepublic boolean hasVersionElement()
public boolean hasVersion()
public ImplementationGuide setVersionElement(StringType value)
value - version (The identifier that is used to identify this version of the Implementation Guide when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the Implementation Guide author manually.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the valuepublic String getVersion()
public ImplementationGuide setVersion(String value)
value - The identifier that is used to identify this version of the Implementation Guide when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the Implementation Guide author manually.public StringType getNameElement()
name (A free text natural language name identifying the Implementation Guide.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the valuepublic boolean hasNameElement()
public boolean hasName()
public ImplementationGuide setNameElement(StringType value)
value - name (A free text natural language name identifying the Implementation Guide.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the valuepublic String getName()
public ImplementationGuide setName(String value)
value - A free text natural language name identifying the Implementation Guide.public Enumeration<Enumerations.ConformanceResourceStatus> getStatusElement()
status (The status of the Implementation Guide.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the valuepublic boolean hasStatusElement()
public boolean hasStatus()
public ImplementationGuide setStatusElement(Enumeration<Enumerations.ConformanceResourceStatus> value)
value - status (The status of the Implementation Guide.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the valuepublic Enumerations.ConformanceResourceStatus getStatus()
public ImplementationGuide setStatus(Enumerations.ConformanceResourceStatus value)
value - The status of the Implementation Guide.public BooleanType getExperimentalElement()
experimental (This Implementation Guide was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the valuepublic boolean hasExperimentalElement()
public boolean hasExperimental()
public ImplementationGuide setExperimentalElement(BooleanType value)
value - experimental (This Implementation Guide was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the valuepublic boolean getExperimental()
public ImplementationGuide setExperimental(boolean value)
value - This Implementation Guide was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.public StringType getPublisherElement()
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 valuepublic boolean hasPublisherElement()
public boolean hasPublisher()
public ImplementationGuide setPublisherElement(StringType value)
value - publisher (The name of the individual or organization that published the implementation guide.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the valuepublic String getPublisher()
public ImplementationGuide setPublisher(String value)
value - The name of the individual or organization that published the implementation guide.public List<ImplementationGuide.ImplementationGuideContactComponent> getContact()
contact (Contacts to assist a user in finding and communicating with the publisher.)public boolean hasContact()
public ImplementationGuide.ImplementationGuideContactComponent addContact()
contact (Contacts to assist a user in finding and communicating with the publisher.)public ImplementationGuide addContact(ImplementationGuide.ImplementationGuideContactComponent t)
public DateTimeType getDateElement()
date (The date this version of the implementation guide was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the implementation guide changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the valuepublic boolean hasDateElement()
public boolean hasDate()
public ImplementationGuide setDateElement(DateTimeType value)
value - date (The date this version of the implementation guide was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the implementation guide changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the valuepublic Date getDate()
public ImplementationGuide setDate(Date value)
value - The date this version of the implementation guide was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the implementation guide changes.public StringType getDescriptionElement()
description (A free text natural language description of the Implementation Guide and its use.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the valuepublic boolean hasDescriptionElement()
public boolean hasDescription()
public ImplementationGuide setDescriptionElement(StringType value)
value - description (A free text natural language description of the Implementation Guide and its use.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the valuepublic String getDescription()
public ImplementationGuide setDescription(String value)
value - A free text natural language description of the Implementation Guide and its use.public List<CodeableConcept> getUseContext()
useContext (The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of implementation guides. The most common use of this element is to represent the country / jurisdiction for which this implementation guide was defined.)public boolean hasUseContext()
public CodeableConcept addUseContext()
useContext (The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of implementation guides. The most common use of this element is to represent the country / jurisdiction for which this implementation guide was defined.)public ImplementationGuide addUseContext(CodeableConcept t)
public StringType getCopyrightElement()
copyright (A copyright statement relating to the implementation guide and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the details of the constraints and mappings.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the valuepublic boolean hasCopyrightElement()
public boolean hasCopyright()
public ImplementationGuide setCopyrightElement(StringType value)
value - copyright (A copyright statement relating to the implementation guide and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the details of the constraints and mappings.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the valuepublic String getCopyright()
public ImplementationGuide setCopyright(String value)
value - A copyright statement relating to the implementation guide and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the details of the constraints and mappings.public IdType getFhirVersionElement()
fhirVersion (The version of the FHIR specification on which this ImplementationGuide is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 1.4.0 for this version.). This is the underlying object with id, value and extensions. The accessor "getFhirVersion" gives direct access to the valuepublic boolean hasFhirVersionElement()
public boolean hasFhirVersion()
public ImplementationGuide setFhirVersionElement(IdType value)
value - fhirVersion (The version of the FHIR specification on which this ImplementationGuide is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 1.4.0 for this version.). This is the underlying object with id, value and extensions. The accessor "getFhirVersion" gives direct access to the valuepublic String getFhirVersion()
public ImplementationGuide setFhirVersion(String value)
value - The version of the FHIR specification on which this ImplementationGuide is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 1.4.0 for this version.public List<ImplementationGuide.ImplementationGuideDependencyComponent> getDependency()
dependency (Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.)public boolean hasDependency()
public ImplementationGuide.ImplementationGuideDependencyComponent addDependency()
dependency (Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.)public ImplementationGuide addDependency(ImplementationGuide.ImplementationGuideDependencyComponent t)
public List<ImplementationGuide.ImplementationGuidePackageComponent> getPackage()
package_ (A logical group of resources. Logical groups can be used when building pages.)public boolean hasPackage()
public ImplementationGuide.ImplementationGuidePackageComponent addPackage()
package_ (A logical group of resources. Logical groups can be used when building pages.)public ImplementationGuide addPackage(ImplementationGuide.ImplementationGuidePackageComponent t)
public List<ImplementationGuide.ImplementationGuideGlobalComponent> getGlobal()
global (A set of profiles that all resources covered by this implementation guide must conform to.)public boolean hasGlobal()
public ImplementationGuide.ImplementationGuideGlobalComponent addGlobal()
global (A set of profiles that all resources covered by this implementation guide must conform to.)public ImplementationGuide addGlobal(ImplementationGuide.ImplementationGuideGlobalComponent t)
public List<UriType> getBinary()
binary (A binary file that is included in the implementation guide when it is published.)public boolean hasBinary()
public UriType addBinaryElement()
binary (A binary file that is included in the implementation guide when it is published.)public ImplementationGuide addBinary(String value)
value - binary (A binary file that is included in the implementation guide when it is published.)public boolean hasBinary(String value)
value - binary (A binary file that is included in the implementation guide when it is published.)public ImplementationGuide.ImplementationGuidePageComponent getPage()
page (A page / section in the implementation guide. The root page is the implementation guide home page.)public boolean hasPage()
public ImplementationGuide setPage(ImplementationGuide.ImplementationGuidePageComponent value)
value - page (A page / section in the implementation guide. The root page is the implementation guide home page.)protected void listChildren(List<Property> childrenList)
listChildren in class DomainResourcepublic Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
getProperty in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic void setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
setProperty in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic void setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
setProperty in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
makeProperty in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
addChild in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic String fhirType()
fhirType in class DomainResourcepublic ImplementationGuide copy()
copy in class DomainResourceprotected ImplementationGuide typedCopy()
public boolean equalsDeep(Base other)
equalsDeep in class DomainResourcepublic boolean equalsShallow(Base other)
equalsShallow in class DomainResourcepublic boolean isEmpty()
isEmpty in interface org.hl7.fhir.instance.model.api.IBaseisEmpty in class DomainResourcepublic ResourceType getResourceType()
getResourceType in class ResourceCopyright © 2014–2018 University Health Network. All rights reserved.