Class MessageDefinition
- 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:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
static class
static enum
static class
static enum
static class
-
Field Summary
Modifier and TypeFieldDescriptionIndicates what types of messages may be sent as an application-level response to this message.protected CanonicalType
The MessageDefinition that is the basis for the contents of this resource.The impact of the content of the message.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for categorystatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for contextstatic final ca.uhn.fhir.rest.gclient.QuantityClientParam
Fluent Client search parameter constant for context-quantitystatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for context-typestatic final ca.uhn.fhir.rest.gclient.CompositeClientParam
<ca.uhn.fhir.rest.gclient.TokenClientParam, ca.uhn.fhir.rest.gclient.QuantityClientParam> Fluent Client search parameter constant for context-type-quantitystatic final ca.uhn.fhir.rest.gclient.CompositeClientParam
<ca.uhn.fhir.rest.gclient.TokenClientParam, ca.uhn.fhir.rest.gclient.TokenClientParam> Fluent Client search parameter constant for context-type-valueprotected MarkdownType
A copyright statement relating to the message definition and/or its contents.static final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for datestatic final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for descriptionprotected Type
Event code or link to the EventDefinition.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for eventIdentifies the resource (or resources) that are being addressed by the event.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for focusprotected List
<CanonicalType> Canonical reference to a GraphDefinition.protected List
<Identifier> A formal identifier that is used to identify this message 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.rest.gclient.TokenClientParam
Fluent Client search parameter constant for jurisdictionstatic final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for nameprotected List
<CanonicalType> Identifies a protocol or workflow that this MessageDefinition represents a step in.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for parentstatic final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for publisherprotected MarkdownType
Explanation of why this message definition is needed and why it has been designed as it has.protected List
<CanonicalType> A MessageDefinition that is superseded by this definition.Declare at a message definition level whether a response is required or only upon error or success, or never.static final String
Search parameter: categorystatic final String
Search parameter: contextstatic final String
Search parameter: context-quantitystatic final String
Search parameter: context-typestatic final String
Search parameter: context-type-quantitystatic final String
Search parameter: context-type-valuestatic final String
Search parameter: datestatic final String
Search parameter: descriptionstatic final String
Search parameter: eventstatic final String
Search parameter: focusstatic final String
Search parameter: identifierstatic final String
Search parameter: jurisdictionstatic final String
Search parameter: namestatic final String
Search parameter: parentstatic final String
Search parameter: publisherstatic final String
Search parameter: statusstatic final String
Search parameter: titlestatic 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.StringClientParam
Fluent Client search parameter constant for titlestatic final ca.uhn.fhir.rest.gclient.UriClientParam
Fluent Client search parameter constant for urlstatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for versionFields 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
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
ConstructorDescriptionConstructorMessageDefinition
(Enumeration<Enumerations.PublicationStatus> status, DateTimeType date, Type event) Constructor -
Method Summary
Modifier and TypeMethodDescriptionaddFocus()
addReplaces
(String value) copy()
void
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getBase()
getDate()
getEvent()
boolean
getFocus()
getGraph()
getName()
getNamedProperty
(int _hash, String _name, boolean _checkValid) Base[]
getProperty
(int hash, String name, boolean checkValid) getTitle()
String[]
getTypesForProperty
(int hash, String name) getUrl()
boolean
boolean
hasBase()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasDate()
boolean
boolean
boolean
boolean
hasEvent()
boolean
boolean
boolean
boolean
boolean
hasFocus()
boolean
hasGraph()
boolean
boolean
boolean
boolean
hasName()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasReplaces
(String value) boolean
boolean
boolean
boolean
boolean
hasTitle()
boolean
boolean
hasUrl()
boolean
boolean
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setAllowedResponse
(List<MessageDefinition.MessageDefinitionAllowedResponseComponent> theAllowedResponse) setBaseElement
(CanonicalType value) setContact
(List<ContactDetail> theContact) setCopyright
(String value) setCopyrightElement
(MarkdownType value) setDateElement
(DateTimeType value) setDescription
(String value) setExperimental
(boolean value) setGraph
(List<CanonicalType> theGraph) setIdentifier
(List<Identifier> theIdentifier) setJurisdiction
(List<CodeableConcept> theJurisdiction) setNameElement
(StringType value) setParent
(List<CanonicalType> theParent) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setPublisher
(String value) setPublisherElement
(StringType value) setPurpose
(String value) setPurposeElement
(MarkdownType value) setReplaces
(List<CanonicalType> theReplaces) setTitleElement
(StringType value) setUrlElement
(UriType value) setUseContext
(List<UsageContext> theUseContext) setVersion
(String value) setVersionElement
(StringType value) protected MessageDefinition
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, 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, getIdPart, 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, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, 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
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 message definition when it is represented in other formats, or referenced in a specification, model, design or an instance. -
replaces
A MessageDefinition that is superseded by this definition. -
purpose
Explanation of why this message definition is needed and why it has been designed as it has. -
copyright
A copyright statement relating to the message definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the message definition. -
base
The MessageDefinition that is the basis for the contents of this resource. -
parent
Identifies a protocol or workflow that this MessageDefinition represents a step in. -
event
Event code or link to the EventDefinition. -
category
The impact of the content of the message. -
focus
Identifies the resource (or resources) that are being addressed by the event. For example, the Encounter for an admit message or two Account records for a merge. -
responseRequired
Declare at a message definition level whether a response is required or only upon error or success, or never. -
allowedResponse
Indicates what types of messages may be sent as an application-level response to this message. -
graph
Canonical reference to a GraphDefinition. If a URL is provided, it is the canonical reference to a [[[GraphDefinition]]] that it controls what resources are to be added to the bundle when building the document. The GraphDefinition can also specify profiles that apply to the various resources. -
SP_DATE
Search parameter: dateDescription: The message definition publication date
Type: date
Path: MessageDefinition.date
- See Also:
-
DATE
Fluent Client search parameter constant for dateDescription: The message definition publication date
Type: date
Path: MessageDefinition.date
-
SP_IDENTIFIER
Search parameter: identifierDescription: External identifier for the message definition
Type: token
Path: MessageDefinition.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: External identifier for the message definition
Type: token
Path: MessageDefinition.identifier
-
SP_PARENT
Search parameter: parentDescription: A resource that is the parent of the definition
Type: reference
Path: MessageDefinition.parent
- See Also:
-
PARENT
Fluent Client search parameter constant for parentDescription: A resource that is the parent of the definition
Type: reference
Path: MessageDefinition.parent
-
INCLUDE_PARENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "MessageDefinition:parent". -
SP_CONTEXT_TYPE_VALUE
Search parameter: context-type-valueDescription: A use context type and value assigned to the message definition
Type: composite
Path:
- See Also:
-
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_VALUEFluent Client search parameter constant for context-type-valueDescription: A use context type and value assigned to the message definition
Type: composite
Path:
-
SP_JURISDICTION
Search parameter: jurisdictionDescription: Intended jurisdiction for the message definition
Type: token
Path: MessageDefinition.jurisdiction
- See Also:
-
JURISDICTION
Fluent Client search parameter constant for jurisdictionDescription: Intended jurisdiction for the message definition
Type: token
Path: MessageDefinition.jurisdiction
-
SP_DESCRIPTION
Search parameter: descriptionDescription: The description of the message definition
Type: string
Path: MessageDefinition.description
- See Also:
-
DESCRIPTION
Fluent Client search parameter constant for descriptionDescription: The description of the message definition
Type: string
Path: MessageDefinition.description
-
SP_FOCUS
Search parameter: focusDescription: A resource that is a permitted focus of the message
Type: token
Path: MessageDefinition.focus.code
- See Also:
-
FOCUS
Fluent Client search parameter constant for focusDescription: A resource that is a permitted focus of the message
Type: token
Path: MessageDefinition.focus.code
-
SP_CONTEXT_TYPE
Search parameter: context-typeDescription: A type of use context assigned to the message definition
Type: token
Path: MessageDefinition.useContext.code
- See Also:
-
CONTEXT_TYPE
Fluent Client search parameter constant for context-typeDescription: A type of use context assigned to the message definition
Type: token
Path: MessageDefinition.useContext.code
-
SP_TITLE
Search parameter: titleDescription: The human-friendly name of the message definition
Type: string
Path: MessageDefinition.title
- See Also:
-
TITLE
Fluent Client search parameter constant for titleDescription: The human-friendly name of the message definition
Type: string
Path: MessageDefinition.title
-
SP_VERSION
Search parameter: versionDescription: The business version of the message definition
Type: token
Path: MessageDefinition.version
- See Also:
-
VERSION
Fluent Client search parameter constant for versionDescription: The business version of the message definition
Type: token
Path: MessageDefinition.version
-
SP_URL
Search parameter: urlDescription: The uri that identifies the message definition
Type: uri
Path: MessageDefinition.url
- See Also:
-
URL
Fluent Client search parameter constant for urlDescription: The uri that identifies the message definition
Type: uri
Path: MessageDefinition.url
-
SP_CONTEXT_QUANTITY
Search parameter: context-quantityDescription: A quantity- or range-valued use context assigned to the message definition
Type: quantity
Path: MessageDefinition.useContext.valueQuantity, MessageDefinition.useContext.valueRange
- See Also:
-
CONTEXT_QUANTITY
Fluent Client search parameter constant for context-quantityDescription: A quantity- or range-valued use context assigned to the message definition
Type: quantity
Path: MessageDefinition.useContext.valueQuantity, MessageDefinition.useContext.valueRange
-
SP_NAME
Search parameter: nameDescription: Computationally friendly name of the message definition
Type: string
Path: MessageDefinition.name
- See Also:
-
NAME
Fluent Client search parameter constant for nameDescription: Computationally friendly name of the message definition
Type: string
Path: MessageDefinition.name
-
SP_CONTEXT
Search parameter: contextDescription: A use context assigned to the message definition
Type: token
Path: MessageDefinition.useContext.valueCodeableConcept
- See Also:
-
CONTEXT
Fluent Client search parameter constant for contextDescription: A use context assigned to the message definition
Type: token
Path: MessageDefinition.useContext.valueCodeableConcept
-
SP_PUBLISHER
Search parameter: publisherDescription: Name of the publisher of the message definition
Type: string
Path: MessageDefinition.publisher
- See Also:
-
PUBLISHER
Fluent Client search parameter constant for publisherDescription: Name of the publisher of the message definition
Type: string
Path: MessageDefinition.publisher
-
SP_EVENT
Search parameter: eventDescription: The event that triggers the message or link to the event definition.
Type: token
Path: MessageDefinition.event[x]
- See Also:
-
EVENT
Fluent Client search parameter constant for eventDescription: The event that triggers the message or link to the event definition.
Type: token
Path: MessageDefinition.event[x]
-
SP_CATEGORY
Search parameter: categoryDescription: The behavior associated with the message
Type: token
Path: MessageDefinition.category
- See Also:
-
CATEGORY
Fluent Client search parameter constant for categoryDescription: The behavior associated with the message
Type: token
Path: MessageDefinition.category
-
SP_CONTEXT_TYPE_QUANTITY
Search parameter: context-type-quantityDescription: A use context type and quantity- or range-based value assigned to the message definition
Type: composite
Path:
- See Also:
-
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_QUANTITYFluent Client search parameter constant for context-type-quantityDescription: A use context type and quantity- or range-based value assigned to the message definition
Type: composite
Path:
-
SP_STATUS
Search parameter: statusDescription: The current status of the message definition
Type: token
Path: MessageDefinition.status
- See Also:
-
STATUS
Fluent Client search parameter constant for statusDescription: The current status of the message definition
Type: token
Path: MessageDefinition.status
-
-
Constructor Details
-
MessageDefinition
public MessageDefinition()Constructor -
MessageDefinition
public MessageDefinition(Enumeration<Enumerations.PublicationStatus> status, DateTimeType date, Type event) Constructor
-
-
Method Details
-
getUrlElement
- Overrides:
getUrlElement
in classMetadataResource
- Returns:
MetadataResource.url
(The business identifier that is used to reference the MessageDefinition and *is* expected to be consistent from server to server.). 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
(The business identifier that is used to reference the MessageDefinition and *is* expected to be consistent from server to server.). 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:
- The business identifier that is used to reference the MessageDefinition and *is* expected to be consistent from server to server.
-
setUrl
- Overrides:
setUrl
in classMetadataResource
- Parameters:
value
- The business identifier that is used to reference the MessageDefinition and *is* expected to be consistent from server to server.
-
getIdentifier
- Returns:
identifier
(A formal identifier that is used to identify this message definition when it is represented in other formats, or referenced in a specification, model, design or an instance.)
-
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 message definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the message 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 message definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the message 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 message definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the message 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 message definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the message 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 message 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 message 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 message 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 message 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 message 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 message 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 message definition.
-
setTitle
- Overrides:
setTitle
in classMetadataResource
- Parameters:
value
- A short, descriptive, user-friendly title for the message definition.
-
getReplaces
- Returns:
replaces
(A MessageDefinition that is superseded by this definition.)
-
setReplaces
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasReplaces
-
addReplacesElement
- Returns:
replaces
(A MessageDefinition that is superseded by this definition.)
-
addReplaces
- Parameters:
value
-replaces
(A MessageDefinition that is superseded by this definition.)
-
hasReplaces
- Parameters:
value
-replaces
(A MessageDefinition that is superseded by this definition.)
-
getStatusElement
- Overrides:
getStatusElement
in classMetadataResource
- Returns:
MetadataResource.status
(The status of this message 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 message 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 message definition. Enables tracking the life-cycle of the content.
-
setStatus
- Overrides:
setStatus
in classMetadataResource
- Parameters:
value
- The status of this message definition. Enables tracking the life-cycle of the content.
-
getExperimentalElement
- Overrides:
getExperimentalElement
in classMetadataResource
- Returns:
MetadataResource.experimental
(A Boolean value to indicate that this message 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 message 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 message 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 message 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 message definition 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 message 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 message definition 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 message 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 message definition 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 message definition changes.
-
setDate
- Overrides:
setDate
in classMetadataResource
- Parameters:
value
- The date (and optionally time) when the message definition 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 message definition changes.
-
getPublisherElement
- Overrides:
getPublisherElement
in classMetadataResource
- Returns:
MetadataResource.publisher
(The name of the organization or individual that published the message 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 organization or individual that published the message 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 organization or individual that published the message definition.
-
setPublisher
- Overrides:
setPublisher
in classMetadataResource
- Parameters:
value
- The name of the organization or individual that published the message definition.
-
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
-
getDescriptionElement
- Overrides:
getDescriptionElement
in classMetadataResource
- Returns:
MetadataResource.description
(A free text natural language description of the message 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 message 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 message definition from a consumer's perspective.
-
setDescription
- Overrides:
setDescription
in classMetadataResource
- Parameters:
value
- A free text natural language description of the message definition from a consumer's perspective.
-
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 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 message 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 message 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
-
getPurposeElement
- Returns:
purpose
(Explanation of why this message 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
(Explanation of why this message 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:
- Explanation of why this message definition is needed and why it has been designed as it has.
-
setPurpose
- Parameters:
value
- Explanation of why this message definition is needed and why it has been designed as it has.
-
getCopyrightElement
- Returns:
copyright
(A copyright statement relating to the message definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the message 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 message definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the message 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 message definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the message definition.
-
setCopyright
- Parameters:
value
- A copyright statement relating to the message definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the message definition.
-
getBaseElement
- Returns:
base
(The MessageDefinition that is the basis for the contents of this resource.). This is the underlying object with id, value and extensions. The accessor "getBase" gives direct access to the value
-
hasBaseElement
-
hasBase
-
setBaseElement
- Parameters:
value
-base
(The MessageDefinition that is the basis for the contents of this resource.). This is the underlying object with id, value and extensions. The accessor "getBase" gives direct access to the value
-
getBase
- Returns:
- The MessageDefinition that is the basis for the contents of this resource.
-
setBase
- Parameters:
value
- The MessageDefinition that is the basis for the contents of this resource.
-
getParent
- Returns:
parent
(Identifies a protocol or workflow that this MessageDefinition represents a step in.)
-
setParent
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasParent
-
addParentElement
- Returns:
parent
(Identifies a protocol or workflow that this MessageDefinition represents a step in.)
-
addParent
- Parameters:
value
-parent
(Identifies a protocol or workflow that this MessageDefinition represents a step in.)
-
hasParent
- Parameters:
value
-parent
(Identifies a protocol or workflow that this MessageDefinition represents a step in.)
-
getEvent
- Returns:
event
(Event code or link to the EventDefinition.)
-
getEventCoding
- Returns:
event
(Event code or link to the EventDefinition.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasEventCoding
-
getEventUriType
- Returns:
event
(Event code or link to the EventDefinition.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasEventUriType
-
hasEvent
-
setEvent
- Parameters:
value
-event
(Event code or link to the EventDefinition.)
-
getCategoryElement
- Returns:
category
(The impact of the content of the message.). This is the underlying object with id, value and extensions. The accessor "getCategory" gives direct access to the value
-
hasCategoryElement
-
hasCategory
-
setCategoryElement
public MessageDefinition setCategoryElement(Enumeration<MessageDefinition.MessageSignificanceCategory> value) - Parameters:
value
-category
(The impact of the content of the message.). This is the underlying object with id, value and extensions. The accessor "getCategory" gives direct access to the value
-
getCategory
- Returns:
- The impact of the content of the message.
-
setCategory
- Parameters:
value
- The impact of the content of the message.
-
getFocus
- Returns:
focus
(Identifies the resource (or resources) that are being addressed by the event. For example, the Encounter for an admit message or two Account records for a merge.)
-
setFocus
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasFocus
-
addFocus
-
addFocus
-
getFocusFirstRep
- Returns:
- The first repetition of repeating field
focus
, creating it if it does not already exist
-
getResponseRequiredElement
- Returns:
responseRequired
(Declare at a message definition level whether a response is required or only upon error or success, or never.). This is the underlying object with id, value and extensions. The accessor "getResponseRequired" gives direct access to the value
-
hasResponseRequiredElement
-
hasResponseRequired
-
setResponseRequiredElement
public MessageDefinition setResponseRequiredElement(Enumeration<MessageDefinition.MessageheaderResponseRequest> value) - Parameters:
value
-responseRequired
(Declare at a message definition level whether a response is required or only upon error or success, or never.). This is the underlying object with id, value and extensions. The accessor "getResponseRequired" gives direct access to the value
-
getResponseRequired
- Returns:
- Declare at a message definition level whether a response is required or only upon error or success, or never.
-
setResponseRequired
- Parameters:
value
- Declare at a message definition level whether a response is required or only upon error or success, or never.
-
getAllowedResponse
- Returns:
allowedResponse
(Indicates what types of messages may be sent as an application-level response to this message.)
-
setAllowedResponse
public MessageDefinition setAllowedResponse(List<MessageDefinition.MessageDefinitionAllowedResponseComponent> theAllowedResponse) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasAllowedResponse
-
addAllowedResponse
-
addAllowedResponse
-
getAllowedResponseFirstRep
- Returns:
- The first repetition of repeating field
allowedResponse
, creating it if it does not already exist
-
getGraph
- Returns:
graph
(Canonical reference to a GraphDefinition. If a URL is provided, it is the canonical reference to a [[[GraphDefinition]]] that it controls what resources are to be added to the bundle when building the document. The GraphDefinition can also specify profiles that apply to the various resources.)
-
setGraph
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasGraph
-
addGraphElement
- Returns:
graph
(Canonical reference to a GraphDefinition. If a URL is provided, it is the canonical reference to a [[[GraphDefinition]]] that it controls what resources are to be added to the bundle when building the document. The GraphDefinition can also specify profiles that apply to the various resources.)
-
addGraph
- Parameters:
value
-graph
(Canonical reference to a GraphDefinition. If a URL is provided, it is the canonical reference to a [[[GraphDefinition]]] that it controls what resources are to be added to the bundle when building the document. The GraphDefinition can also specify profiles that apply to the various resources.)
-
hasGraph
- Parameters:
value
-graph
(Canonical reference to a GraphDefinition. If a URL is provided, it is the canonical reference to a [[[GraphDefinition]]] that it controls what resources are to be added to the bundle when building the document. The GraphDefinition can also specify profiles that apply to the various resources.)
-
listChildren
- Overrides:
listChildren
in classMetadataResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classDomainResource
- 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
-
removeChild
- Overrides:
removeChild
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
-
copyValues
-
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
-