Class ServiceDefinition
- 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
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionprotected DateType
The date on which the resource content was approved by the publisher.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for composed-ofprotected List
<Contributor> A contributor to the content of the module, including authors, editors, reviewers, and endorsers.protected MarkdownType
A copyright statement relating to the service definition and/or its contents.protected List
<DataRequirement> Data requirements are a machine processable description of the data required by the module in order to perform a successful evaluation.static final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for datestatic final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for depends-onstatic final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for derived-fromstatic final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for descriptionstatic final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for effectiveprotected Period
The period during which the service definition content was or is planned to be in active use.protected List
<Identifier> A formal identifier that is used to identify this service definition when it is represented in other formats, or referenced in a specification, model, design or an instance.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for identifierstatic final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for jurisdictionprotected DateType
The date on which the resource content was last reviewed.static final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for nameprotected Reference
A reference to the operation that is used to invoke this service.protected OperationDefinition
The actual object that is the target of the reference (A reference to the operation that is used to invoke this service.)static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for predecessorstatic final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for publisherprotected MarkdownType
Explaination of why this service definition is needed and why it has been designed as it has.protected List
<RelatedArtifact> Related resources such as additional documentation, justification, or bibliographic references.static final String
Search parameter: composed-ofstatic final String
Search parameter: datestatic final String
Search parameter: depends-onstatic final String
Search parameter: derived-fromstatic final String
Search parameter: descriptionstatic final String
Search parameter: effectivestatic final String
Search parameter: identifierstatic final String
Search parameter: jurisdictionstatic final String
Search parameter: namestatic final String
Search parameter: predecessorstatic final String
Search parameter: publisherstatic final String
Search parameter: statusstatic final String
Search parameter: successorstatic final String
Search parameter: titlestatic final String
Search parameter: topicstatic final String
Search parameter: urlstatic final String
Search parameter: versionstatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for statusstatic final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for successorstatic final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for titleprotected List
<CodeableConcept> Descriptive topics related to the module.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for topicprotected List
<TriggerDefinition> The trigger element defines when the rule should be invoked.static final ca.uhn.fhir.rest.gclient.UriClientParam
Fluent Client search parameter constant for urlprotected StringType
A detailed description of how the module is used from a clinical perspective.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for versionFields 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, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
ConstructorDescriptionConstructorConstructor -
Method Summary
Modifier and TypeMethodDescriptionaddTopic()
copy()
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getDate()
boolean
getName()
getNamedProperty
(int _hash, String _name, boolean _checkValid) Base[]
getProperty
(int hash, String name, boolean checkValid) getTitle()
getTopic()
String[]
getTypesForProperty
(int hash, String name) getUrl()
getUsage()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasDate()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasName()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasTitle()
boolean
boolean
hasTopic()
boolean
boolean
hasUrl()
boolean
boolean
hasUsage()
boolean
boolean
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) setApprovalDate
(Date value) setApprovalDateElement
(DateType value) setContact
(List<ContactDetail> theContact) setContributor
(List<Contributor> theContributor) setCopyright
(String value) setCopyrightElement
(MarkdownType value) setDataRequirement
(List<DataRequirement> theDataRequirement) setDateElement
(DateTimeType value) setDescription
(String value) setEffectivePeriod
(Period value) setExperimental
(boolean value) setIdentifier
(List<Identifier> theIdentifier) setJurisdiction
(List<CodeableConcept> theJurisdiction) setLastReviewDate
(Date value) setLastReviewDateElement
(DateType value) setNameElement
(StringType value) setOperationDefinition
(Reference value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setPublisher
(String value) setPublisherElement
(StringType value) setPurpose
(String value) setPurposeElement
(MarkdownType value) setRelatedArtifact
(List<RelatedArtifact> theRelatedArtifact) setTitleElement
(StringType value) setTopic
(List<CodeableConcept> theTopic) setTrigger
(List<TriggerDefinition> theTrigger) setUrlElement
(UriType value) setUsageElement
(StringType value) setUseContext
(List<UsageContext> theUseContext) setVersion
(String value) setVersionElement
(StringType value) protected ServiceDefinition
Methods inherited from class org.hl7.fhir.dstu3.model.MetadataResource
checkCanUseUrl, copyValues, toString
Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
Methods inherited from class org.hl7.fhir.dstu3.model.Resource
copyValues, getId, getIdBase, getIdElement, getIdPart, 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, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, 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.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, isDeleted, setId
-
Field Details
-
identifier
A formal identifier that is used to identify this service definition when it is represented in other formats, or referenced in a specification, model, design or an instance. This is used for CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts. -
purpose
Explaination of why this service definition is needed and why it has been designed as it has. -
usage
A detailed description of how the module is used from a clinical perspective. -
approvalDate
The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. -
lastReviewDate
The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date. -
effectivePeriod
The period during which the service definition content was or is planned to be in active use. -
topic
Descriptive topics related to the module. Topics provide a high-level categorization of the module that can be useful for filtering and searching. -
contributor
A contributor to the content of the module, including authors, editors, reviewers, and endorsers. -
copyright
A copyright statement relating to the service definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the service definition. -
trigger
The trigger element defines when the rule should be invoked. This information is used by consumers of the rule to determine how to integrate the rule into a specific workflow. -
dataRequirement
Data requirements are a machine processable description of the data required by the module in order to perform a successful evaluation. -
operationDefinition
A reference to the operation that is used to invoke this service. -
operationDefinitionTarget
The actual object that is the target of the reference (A reference to the operation that is used to invoke this service.) -
SP_DATE
Search parameter: dateDescription: The service definition publication date
Type: date
Path: ServiceDefinition.date
- See Also:
-
DATE
Fluent Client search parameter constant for dateDescription: The service definition publication date
Type: date
Path: ServiceDefinition.date
-
SP_IDENTIFIER
Search parameter: identifierDescription: External identifier for the service definition
Type: token
Path: ServiceDefinition.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: External identifier for the service definition
Type: token
Path: ServiceDefinition.identifier
-
SP_SUCCESSOR
Search parameter: successorDescription: What resource is being referenced
Type: reference
Path: ServiceDefinition.relatedArtifact.resource
- See Also:
-
SUCCESSOR
Fluent Client search parameter constant for successorDescription: What resource is being referenced
Type: reference
Path: ServiceDefinition.relatedArtifact.resource
-
INCLUDE_SUCCESSOR
Constant for fluent queries to be used to add include statements. Specifies the path value of "ServiceDefinition:successor". -
SP_JURISDICTION
Search parameter: jurisdictionDescription: Intended jurisdiction for the service definition
Type: token
Path: ServiceDefinition.jurisdiction
- See Also:
-
JURISDICTION
Fluent Client search parameter constant for jurisdictionDescription: Intended jurisdiction for the service definition
Type: token
Path: ServiceDefinition.jurisdiction
-
SP_DESCRIPTION
Search parameter: descriptionDescription: The description of the service definition
Type: string
Path: ServiceDefinition.description
- See Also:
-
DESCRIPTION
Fluent Client search parameter constant for descriptionDescription: The description of the service definition
Type: string
Path: ServiceDefinition.description
-
SP_DERIVED_FROM
Search parameter: derived-fromDescription: What resource is being referenced
Type: reference
Path: ServiceDefinition.relatedArtifact.resource
- See Also:
-
DERIVED_FROM
Fluent Client search parameter constant for derived-fromDescription: What resource is being referenced
Type: reference
Path: ServiceDefinition.relatedArtifact.resource
-
INCLUDE_DERIVED_FROM
Constant for fluent queries to be used to add include statements. Specifies the path value of "ServiceDefinition:derived-from". -
SP_PREDECESSOR
Search parameter: predecessorDescription: What resource is being referenced
Type: reference
Path: ServiceDefinition.relatedArtifact.resource
- See Also:
-
PREDECESSOR
Fluent Client search parameter constant for predecessorDescription: What resource is being referenced
Type: reference
Path: ServiceDefinition.relatedArtifact.resource
-
INCLUDE_PREDECESSOR
Constant for fluent queries to be used to add include statements. Specifies the path value of "ServiceDefinition:predecessor". -
SP_TITLE
Search parameter: titleDescription: The human-friendly name of the service definition
Type: string
Path: ServiceDefinition.title
- See Also:
-
TITLE
Fluent Client search parameter constant for titleDescription: The human-friendly name of the service definition
Type: string
Path: ServiceDefinition.title
-
SP_COMPOSED_OF
Search parameter: composed-ofDescription: What resource is being referenced
Type: reference
Path: ServiceDefinition.relatedArtifact.resource
- See Also:
-
COMPOSED_OF
Fluent Client search parameter constant for composed-ofDescription: What resource is being referenced
Type: reference
Path: ServiceDefinition.relatedArtifact.resource
-
INCLUDE_COMPOSED_OF
Constant for fluent queries to be used to add include statements. Specifies the path value of "ServiceDefinition:composed-of". -
SP_VERSION
Search parameter: versionDescription: The business version of the service definition
Type: token
Path: ServiceDefinition.version
- See Also:
-
VERSION
Fluent Client search parameter constant for versionDescription: The business version of the service definition
Type: token
Path: ServiceDefinition.version
-
SP_URL
Search parameter: urlDescription: The uri that identifies the service definition
Type: uri
Path: ServiceDefinition.url
- See Also:
-
URL
Fluent Client search parameter constant for urlDescription: The uri that identifies the service definition
Type: uri
Path: ServiceDefinition.url
-
SP_EFFECTIVE
Search parameter: effectiveDescription: The time during which the service definition is intended to be in use
Type: date
Path: ServiceDefinition.effectivePeriod
- See Also:
-
EFFECTIVE
Fluent Client search parameter constant for effectiveDescription: The time during which the service definition is intended to be in use
Type: date
Path: ServiceDefinition.effectivePeriod
-
SP_DEPENDS_ON
Search parameter: depends-onDescription: What resource is being referenced
Type: reference
Path: ServiceDefinition.relatedArtifact.resource
- See Also:
-
DEPENDS_ON
Fluent Client search parameter constant for depends-onDescription: What resource is being referenced
Type: reference
Path: ServiceDefinition.relatedArtifact.resource
-
INCLUDE_DEPENDS_ON
Constant for fluent queries to be used to add include statements. Specifies the path value of "ServiceDefinition:depends-on". -
SP_NAME
Search parameter: nameDescription: Computationally friendly name of the service definition
Type: string
Path: ServiceDefinition.name
- See Also:
-
NAME
Fluent Client search parameter constant for nameDescription: Computationally friendly name of the service definition
Type: string
Path: ServiceDefinition.name
-
SP_PUBLISHER
Search parameter: publisherDescription: Name of the publisher of the service definition
Type: string
Path: ServiceDefinition.publisher
- See Also:
-
PUBLISHER
Fluent Client search parameter constant for publisherDescription: Name of the publisher of the service definition
Type: string
Path: ServiceDefinition.publisher
-
SP_TOPIC
Search parameter: topicDescription: Topics associated with the module
Type: token
Path: ServiceDefinition.topic
- See Also:
-
TOPIC
Fluent Client search parameter constant for topicDescription: Topics associated with the module
Type: token
Path: ServiceDefinition.topic
-
SP_STATUS
Search parameter: statusDescription: The current status of the service definition
Type: token
Path: ServiceDefinition.status
- See Also:
-
STATUS
Fluent Client search parameter constant for statusDescription: The current status of the service definition
Type: token
Path: ServiceDefinition.status
-
-
Constructor Details
-
ServiceDefinition
public ServiceDefinition()Constructor -
ServiceDefinition
Constructor
-
-
Method Details
-
getUrlElement
- Overrides:
getUrlElement
in classMetadataResource
- Returns:
MetadataResource.url
(An absolute URI that is used to identify this service definition 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 service definition is (or will be) published. The URL SHOULD include the major version of the service definition. 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
- Overrides:
hasUrlElement
in classMetadataResource
-
hasUrl
- Overrides:
hasUrl
in classMetadataResource
-
setUrlElement
- Overrides:
setUrlElement
in classMetadataResource
- Parameters:
value
-MetadataResource.url
(An absolute URI that is used to identify this service definition 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 service definition is (or will be) published. The URL SHOULD include the major version of the service definition. 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
- Overrides:
getUrl
in classMetadataResource
- Returns:
- An absolute URI that is used to identify this service definition 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 service definition is (or will be) published. The URL SHOULD include the major version of the service definition. For more information see [Technical and Business Versions](resource.html#versions).
-
setUrl
- Overrides:
setUrl
in classMetadataResource
- Parameters:
value
- An absolute URI that is used to identify this service definition 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 service definition is (or will be) published. The URL SHOULD include the major version of the service definition. For more information see [Technical and Business Versions](resource.html#versions).
-
getIdentifier
- Returns:
identifier
(A formal identifier that is used to identify this service definition when it is represented in other formats, or referenced in a specification, model, design or an instance. This is used for CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts.)
-
setIdentifier
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIdentifier
-
addIdentifier
-
addIdentifier
-
getIdentifierFirstRep
- Returns:
- The first repetition of repeating field
identifier
, creating it if it does not already exist
-
getVersionElement
- Overrides:
getVersionElement
in classMetadataResource
- Returns:
MetadataResource.version
(The identifier that is used to identify this version of the service definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the service definition 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
- Overrides:
hasVersionElement
in classMetadataResource
-
hasVersion
- Overrides:
hasVersion
in classMetadataResource
-
setVersionElement
- Overrides:
setVersionElement
in classMetadataResource
- Parameters:
value
-MetadataResource.version
(The identifier that is used to identify this version of the service definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the service definition 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
- Overrides:
getVersion
in classMetadataResource
- Returns:
- The identifier that is used to identify this version of the service definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the service definition 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
- Overrides:
setVersion
in classMetadataResource
- Parameters:
value
- The identifier that is used to identify this version of the service definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the service definition 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
- Overrides:
getNameElement
in classMetadataResource
- Returns:
MetadataResource.name
(A natural language name identifying the service definition. 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
- Overrides:
hasNameElement
in classMetadataResource
-
hasName
- Overrides:
hasName
in classMetadataResource
-
setNameElement
- Overrides:
setNameElement
in classMetadataResource
- Parameters:
value
-MetadataResource.name
(A natural language name identifying the service definition. 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
- Overrides:
getName
in classMetadataResource
- Returns:
- A natural language name identifying the service definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
setName
- Overrides:
setName
in classMetadataResource
- Parameters:
value
- A natural language name identifying the service definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
getTitleElement
- Overrides:
getTitleElement
in classMetadataResource
- Returns:
MetadataResource.title
(A short, descriptive, user-friendly title for the service definition.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
-
hasTitleElement
- Overrides:
hasTitleElement
in classMetadataResource
-
hasTitle
- Overrides:
hasTitle
in classMetadataResource
-
setTitleElement
- Overrides:
setTitleElement
in classMetadataResource
- Parameters:
value
-MetadataResource.title
(A short, descriptive, user-friendly title for the service definition.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
-
getTitle
- Overrides:
getTitle
in classMetadataResource
- Returns:
- A short, descriptive, user-friendly title for the service definition.
-
setTitle
- Overrides:
setTitle
in classMetadataResource
- Parameters:
value
- A short, descriptive, user-friendly title for the service definition.
-
getStatusElement
- Overrides:
getStatusElement
in classMetadataResource
- Returns:
MetadataResource.status
(The status of this service definition. 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
- Overrides:
hasStatusElement
in classMetadataResource
-
hasStatus
- Overrides:
hasStatus
in classMetadataResource
-
setStatusElement
- Overrides:
setStatusElement
in classMetadataResource
- Parameters:
value
-MetadataResource.status
(The status of this service definition. 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
- Overrides:
getStatus
in classMetadataResource
- Returns:
- The status of this service definition. Enables tracking the life-cycle of the content.
-
setStatus
- Overrides:
setStatus
in classMetadataResource
- Parameters:
value
- The status of this service definition. Enables tracking the life-cycle of the content.
-
getExperimentalElement
- Overrides:
getExperimentalElement
in classMetadataResource
- Returns:
MetadataResource.experimental
(A boolean value to indicate that this service definition 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
- Overrides:
hasExperimentalElement
in classMetadataResource
-
hasExperimental
- Overrides:
hasExperimental
in classMetadataResource
-
setExperimentalElement
- Overrides:
setExperimentalElement
in classMetadataResource
- Parameters:
value
-MetadataResource.experimental
(A boolean value to indicate that this service definition 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
- Overrides:
getExperimental
in classMetadataResource
- Returns:
- A boolean value to indicate that this service definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
setExperimental
- Overrides:
setExperimental
in classMetadataResource
- Parameters:
value
- A boolean value to indicate that this service definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
getDateElement
- Overrides:
getDateElement
in classMetadataResource
- Returns:
MetadataResource.date
(The date (and optionally time) when the service definition 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 service definition changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
-
hasDateElement
- Overrides:
hasDateElement
in classMetadataResource
-
hasDate
- Overrides:
hasDate
in classMetadataResource
-
setDateElement
- Overrides:
setDateElement
in classMetadataResource
- Parameters:
value
-MetadataResource.date
(The date (and optionally time) when the service definition 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 service definition changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
-
getDate
- Overrides:
getDate
in classMetadataResource
- Returns:
- The date (and optionally time) when the service definition 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 service definition changes.
-
setDate
- Overrides:
setDate
in classMetadataResource
- Parameters:
value
- The date (and optionally time) when the service definition 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 service definition changes.
-
getPublisherElement
- Overrides:
getPublisherElement
in classMetadataResource
- Returns:
MetadataResource.publisher
(The name of the individual or organization that published the service definition.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value
-
hasPublisherElement
- Overrides:
hasPublisherElement
in classMetadataResource
-
hasPublisher
- Overrides:
hasPublisher
in classMetadataResource
-
setPublisherElement
- Overrides:
setPublisherElement
in classMetadataResource
- Parameters:
value
-MetadataResource.publisher
(The name of the individual or organization that published the service definition.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value
-
getPublisher
- Overrides:
getPublisher
in classMetadataResource
- Returns:
- The name of the individual or organization that published the service definition.
-
setPublisher
- Overrides:
setPublisher
in classMetadataResource
- Parameters:
value
- The name of the individual or organization that published the service definition.
-
getDescriptionElement
- Overrides:
getDescriptionElement
in classMetadataResource
- Returns:
MetadataResource.description
(A free text natural language description of the service definition 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
- Overrides:
hasDescriptionElement
in classMetadataResource
-
hasDescription
- Overrides:
hasDescription
in classMetadataResource
-
setDescriptionElement
- Overrides:
setDescriptionElement
in classMetadataResource
- Parameters:
value
-MetadataResource.description
(A free text natural language description of the service definition 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
- Overrides:
getDescription
in classMetadataResource
- Returns:
- A free text natural language description of the service definition from a consumer's perspective.
-
setDescription
- Overrides:
setDescription
in classMetadataResource
- Parameters:
value
- A free text natural language description of the service definition from a consumer's perspective.
-
getPurposeElement
- Returns:
purpose
(Explaination of why this service definition is needed and why it has been designed as it has.). This is the underlying object with id, value and extensions. The accessor "getPurpose" gives direct access to the value
-
hasPurposeElement
-
hasPurpose
-
setPurposeElement
- Parameters:
value
-purpose
(Explaination of why this service definition is needed and why it has been designed as it has.). This is the underlying object with id, value and extensions. The accessor "getPurpose" gives direct access to the value
-
getPurpose
- Returns:
- Explaination of why this service definition is needed and why it has been designed as it has.
-
setPurpose
- Parameters:
value
- Explaination of why this service definition is needed and why it has been designed as it has.
-
getUsageElement
- Returns:
usage
(A detailed description of how the module is used from a clinical perspective.). This is the underlying object with id, value and extensions. The accessor "getUsage" gives direct access to the value
-
hasUsageElement
-
hasUsage
-
setUsageElement
- Parameters:
value
-usage
(A detailed description of how the module is used from a clinical perspective.). This is the underlying object with id, value and extensions. The accessor "getUsage" gives direct access to the value
-
getUsage
- Returns:
- A detailed description of how the module is used from a clinical perspective.
-
setUsage
- Parameters:
value
- A detailed description of how the module is used from a clinical perspective.
-
getApprovalDateElement
- Returns:
approvalDate
(The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.). This is the underlying object with id, value and extensions. The accessor "getApprovalDate" gives direct access to the value
-
hasApprovalDateElement
-
hasApprovalDate
-
setApprovalDateElement
- Parameters:
value
-approvalDate
(The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.). This is the underlying object with id, value and extensions. The accessor "getApprovalDate" gives direct access to the value
-
getApprovalDate
- Returns:
- The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
-
setApprovalDate
- Parameters:
value
- The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
-
getLastReviewDateElement
- Returns:
lastReviewDate
(The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date.). This is the underlying object with id, value and extensions. The accessor "getLastReviewDate" gives direct access to the value
-
hasLastReviewDateElement
-
hasLastReviewDate
-
setLastReviewDateElement
- Parameters:
value
-lastReviewDate
(The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date.). This is the underlying object with id, value and extensions. The accessor "getLastReviewDate" gives direct access to the value
-
getLastReviewDate
- Returns:
- The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date.
-
setLastReviewDate
- Parameters:
value
- The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date.
-
getEffectivePeriod
- Returns:
effectivePeriod
(The period during which the service definition content was or is planned to be in active use.)
-
hasEffectivePeriod
-
setEffectivePeriod
- Parameters:
value
-effectivePeriod
(The period during which the service definition content was or is planned to be in active use.)
-
getUseContext
- Overrides:
getUseContext
in classMetadataResource
- 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 service definition instances.)
-
setUseContext
- Overrides:
setUseContext
in classMetadataResource
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasUseContext
- Overrides:
hasUseContext
in classMetadataResource
-
addUseContext
- Overrides:
addUseContext
in classMetadataResource
-
addUseContext
- Overrides:
addUseContext
in classMetadataResource
-
getUseContextFirstRep
- Overrides:
getUseContextFirstRep
in classMetadataResource
- Returns:
- The first repetition of repeating field
MetadataResource.useContext
, creating it if it does not already exist
-
getJurisdiction
- Overrides:
getJurisdiction
in classMetadataResource
- Returns:
MetadataResource.jurisdiction
(A legal or geographic region in which the service definition is intended to be used.)
-
setJurisdiction
- Overrides:
setJurisdiction
in classMetadataResource
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasJurisdiction
- Overrides:
hasJurisdiction
in classMetadataResource
-
addJurisdiction
- Overrides:
addJurisdiction
in classMetadataResource
-
addJurisdiction
- Overrides:
addJurisdiction
in classMetadataResource
-
getJurisdictionFirstRep
- Overrides:
getJurisdictionFirstRep
in classMetadataResource
- Returns:
- The first repetition of repeating field
MetadataResource.jurisdiction
, creating it if it does not already exist
-
getTopic
- Returns:
topic
(Descriptive topics related to the module. Topics provide a high-level categorization of the module that can be useful for filtering and searching.)
-
setTopic
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasTopic
-
addTopic
-
addTopic
-
getTopicFirstRep
- Returns:
- The first repetition of repeating field
topic
, creating it if it does not already exist
-
getContributor
- Returns:
contributor
(A contributor to the content of the module, including authors, editors, reviewers, and endorsers.)
-
setContributor
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasContributor
-
addContributor
-
addContributor
-
getContributorFirstRep
- Returns:
- The first repetition of repeating field
contributor
, creating it if it does not already exist
-
getContact
- Overrides:
getContact
in classMetadataResource
- Returns:
MetadataResource.contact
(Contact details to assist a user in finding and communicating with the publisher.)
-
setContact
- Overrides:
setContact
in classMetadataResource
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasContact
- Overrides:
hasContact
in classMetadataResource
-
addContact
- Overrides:
addContact
in classMetadataResource
-
addContact
- Overrides:
addContact
in classMetadataResource
-
getContactFirstRep
- Overrides:
getContactFirstRep
in classMetadataResource
- Returns:
- The first repetition of repeating field
MetadataResource.contact
, creating it if it does not already exist
-
getCopyrightElement
- Returns:
copyright
(A copyright statement relating to the service definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the service definition.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value
-
hasCopyrightElement
-
hasCopyright
-
setCopyrightElement
- Parameters:
value
-copyright
(A copyright statement relating to the service definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the service definition.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value
-
getCopyright
- Returns:
- A copyright statement relating to the service definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the service definition.
-
setCopyright
- Parameters:
value
- A copyright statement relating to the service definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the service definition.
-
getRelatedArtifact
- Returns:
relatedArtifact
(Related resources such as additional documentation, justification, or bibliographic references.)
-
setRelatedArtifact
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasRelatedArtifact
-
addRelatedArtifact
-
addRelatedArtifact
-
getRelatedArtifactFirstRep
- Returns:
- The first repetition of repeating field
relatedArtifact
, creating it if it does not already exist
-
getTrigger
- Returns:
trigger
(The trigger element defines when the rule should be invoked. This information is used by consumers of the rule to determine how to integrate the rule into a specific workflow.)
-
setTrigger
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasTrigger
-
addTrigger
-
addTrigger
-
getTriggerFirstRep
- Returns:
- The first repetition of repeating field
trigger
, creating it if it does not already exist
-
getDataRequirement
- Returns:
dataRequirement
(Data requirements are a machine processable description of the data required by the module in order to perform a successful evaluation.)
-
setDataRequirement
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasDataRequirement
-
addDataRequirement
-
addDataRequirement
-
getDataRequirementFirstRep
- Returns:
- The first repetition of repeating field
dataRequirement
, creating it if it does not already exist
-
getOperationDefinition
- Returns:
operationDefinition
(A reference to the operation that is used to invoke this service.)
-
hasOperationDefinition
-
setOperationDefinition
- Parameters:
value
-operationDefinition
(A reference to the operation that is used to invoke this service.)
-
getOperationDefinitionTarget
- Returns:
operationDefinition
The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (A reference to the operation that is used to invoke this service.)
-
setOperationDefinitionTarget
- Parameters:
value
-operationDefinition
The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (A reference to the operation that is used to invoke this service.)
-
listChildren
- Overrides:
listChildren
in classMetadataResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getProperty
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
setProperty
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classMetadataResource
-
copy
- Specified by:
copy
in classMetadataResource
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classMetadataResource
-
equalsShallow
- Overrides:
equalsShallow
in classMetadataResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classMetadataResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-