
Class MessageDefinition
- java.lang.Object
-
- org.hl7.fhir.dstu3.model.Base
-
- org.hl7.fhir.dstu3.model.BaseResource
-
- org.hl7.fhir.dstu3.model.Resource
-
- org.hl7.fhir.dstu3.model.DomainResource
-
- org.hl7.fhir.dstu3.model.MetadataResource
-
- org.hl7.fhir.dstu3.model.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
public class MessageDefinition extends MetadataResource
Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
MessageDefinition.MessageDefinitionAllowedResponseComponent
static class
MessageDefinition.MessageDefinitionFocusComponent
static class
MessageDefinition.MessageSignificanceCategory
static class
MessageDefinition.MessageSignificanceCategoryEnumFactory
-
Field Summary
Fields Modifier and Type Field Description protected List<MessageDefinition.MessageDefinitionAllowedResponseComponent>
allowedResponse
Indicates what types of messages may be sent as an application-level response to this message.protected Reference
base
The MessageDefinition that is the basis for the contents of this resource.protected MessageDefinition
baseTarget
The actual object that is the target of the reference (The MessageDefinition that is the basis for the contents of this resource.)protected Enumeration<MessageDefinition.MessageSignificanceCategory>
category
The impact of the content of the message.static ca.uhn.fhir.rest.gclient.TokenClientParam
CATEGORY
Fluent Client search parameter constant for categoryprotected MarkdownType
copyright
A copyright statement relating to the message definition and/or its contents.static ca.uhn.fhir.rest.gclient.DateClientParam
DATE
Fluent Client search parameter constant for datestatic ca.uhn.fhir.rest.gclient.StringClientParam
DESCRIPTION
Fluent Client search parameter constant for descriptionprotected Coding
event
A coded identifier of a supported messaging event.static ca.uhn.fhir.rest.gclient.TokenClientParam
EVENT
Fluent Client search parameter constant for eventprotected List<MessageDefinition.MessageDefinitionFocusComponent>
focus
Identifies the resource (or resources) that are being addressed by the event.static ca.uhn.fhir.rest.gclient.TokenClientParam
FOCUS
Fluent Client search parameter constant for focusprotected Identifier
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 ca.uhn.fhir.rest.gclient.TokenClientParam
IDENTIFIER
Fluent Client search parameter constant for identifierstatic ca.uhn.fhir.rest.gclient.TokenClientParam
JURISDICTION
Fluent Client search parameter constant for jurisdictionstatic ca.uhn.fhir.rest.gclient.StringClientParam
NAME
Fluent Client search parameter constant for nameprotected List<Reference>
parent
Identifies a protocol or workflow that this MessageDefinition represents a step in.protected List<Resource>
parentTarget
The actual objects that are the target of the reference (Identifies a protocol or workflow that this MessageDefinition represents a step in.)static ca.uhn.fhir.rest.gclient.StringClientParam
PUBLISHER
Fluent Client search parameter constant for publisherprotected MarkdownType
purpose
Explaination of why this message definition is needed and why it has been designed as it has.protected List<Reference>
replaces
A MessageDefinition that is superseded by this definition.protected List<MessageDefinition>
replacesTarget
The actual objects that are the target of the reference (A MessageDefinition that is superseded by this definition.)protected BooleanType
responseRequired
Indicates whether a response is required for this message.static String
SP_CATEGORY
Search parameter: categorystatic String
SP_DATE
Search parameter: datestatic String
SP_DESCRIPTION
Search parameter: descriptionstatic String
SP_EVENT
Search parameter: eventstatic String
SP_FOCUS
Search parameter: focusstatic String
SP_IDENTIFIER
Search parameter: identifierstatic String
SP_JURISDICTION
Search parameter: jurisdictionstatic String
SP_NAME
Search parameter: namestatic String
SP_PUBLISHER
Search parameter: publisherstatic String
SP_STATUS
Search parameter: statusstatic String
SP_TITLE
Search parameter: titlestatic String
SP_URL
Search parameter: urlstatic String
SP_VERSION
Search parameter: versionstatic ca.uhn.fhir.rest.gclient.TokenClientParam
STATUS
Fluent Client search parameter constant for statusstatic ca.uhn.fhir.rest.gclient.StringClientParam
TITLE
Fluent Client search parameter constant for titlestatic ca.uhn.fhir.rest.gclient.UriClientParam
URL
Fluent Client search parameter constant for urlstatic ca.uhn.fhir.rest.gclient.TokenClientParam
VERSION
Fluent Client search parameter constant for version-
Fields inherited from class org.hl7.fhir.dstu3.model.MetadataResource
contact, date, description, experimental, jurisdiction, name, publisher, status, title, url, useContext, version
-
Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.dstu3.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description MessageDefinition()
ConstructorMessageDefinition(Enumeration<Enumerations.PublicationStatus> status, DateTimeType date, Coding event)
Constructor
-
Method Summary
-
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, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.dstu3.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.dstu3.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, 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
-
-
-
-
Field Detail
-
identifier
protected Identifier 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.
-
purpose
protected MarkdownType purpose
Explaination of why this message definition is needed and why it has been designed as it has.
-
copyright
protected MarkdownType 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
protected Reference base
The MessageDefinition that is the basis for the contents of this resource.
-
baseTarget
protected MessageDefinition baseTarget
The actual object that is the target of the reference (The MessageDefinition that is the basis for the contents of this resource.)
-
parent
protected List<Reference> parent
Identifies a protocol or workflow that this MessageDefinition represents a step in.
-
parentTarget
protected List<Resource> parentTarget
The actual objects that are the target of the reference (Identifies a protocol or workflow that this MessageDefinition represents a step in.)
-
replaces
protected List<Reference> replaces
A MessageDefinition that is superseded by this definition.
-
replacesTarget
protected List<MessageDefinition> replacesTarget
The actual objects that are the target of the reference (A MessageDefinition that is superseded by this definition.)
-
category
protected Enumeration<MessageDefinition.MessageSignificanceCategory> category
The impact of the content of the message.
-
focus
protected List<MessageDefinition.MessageDefinitionFocusComponent> 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
protected BooleanType responseRequired
Indicates whether a response is required for this message.
-
allowedResponse
protected List<MessageDefinition.MessageDefinitionAllowedResponseComponent> allowedResponse
Indicates what types of messages may be sent as an application-level response to this message.
-
SP_DATE
public static final String SP_DATE
Search parameter: dateDescription: The message definition publication date
Type: date
Path: MessageDefinition.date
- See Also:
- Constant Field Values
-
DATE
public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
Fluent Client search parameter constant for dateDescription: The message definition publication date
Type: date
Path: MessageDefinition.date
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: External identifier for the message definition
Type: token
Path: MessageDefinition.identifier
- See Also:
- Constant Field Values
-
IDENTIFIER
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
Fluent Client search parameter constant for identifierDescription: External identifier for the message definition
Type: token
Path: MessageDefinition.identifier
-
SP_JURISDICTION
public static final String SP_JURISDICTION
Search parameter: jurisdictionDescription: Intended jurisdiction for the message definition
Type: token
Path: MessageDefinition.jurisdiction
- See Also:
- Constant Field Values
-
JURISDICTION
public static final ca.uhn.fhir.rest.gclient.TokenClientParam JURISDICTION
Fluent Client search parameter constant for jurisdictionDescription: Intended jurisdiction for the message definition
Type: token
Path: MessageDefinition.jurisdiction
-
SP_DESCRIPTION
public static final String SP_DESCRIPTION
Search parameter: descriptionDescription: The description of the message definition
Type: string
Path: MessageDefinition.description
- See Also:
- Constant Field Values
-
DESCRIPTION
public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION
Fluent Client search parameter constant for descriptionDescription: The description of the message definition
Type: string
Path: MessageDefinition.description
-
SP_FOCUS
public static final String SP_FOCUS
Search parameter: focusDescription: A resource that is a permitted focus of the message
Type: token
Path: MessageDefinition.focus.code
- See Also:
- Constant Field Values
-
FOCUS
public static final ca.uhn.fhir.rest.gclient.TokenClientParam 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_TITLE
public static final String SP_TITLE
Search parameter: titleDescription: The human-friendly name of the message definition
Type: string
Path: MessageDefinition.title
- See Also:
- Constant Field Values
-
TITLE
public static final ca.uhn.fhir.rest.gclient.StringClientParam TITLE
Fluent Client search parameter constant for titleDescription: The human-friendly name of the message definition
Type: string
Path: MessageDefinition.title
-
SP_VERSION
public static final String SP_VERSION
Search parameter: versionDescription: The business version of the message definition
Type: token
Path: MessageDefinition.version
- See Also:
- Constant Field Values
-
VERSION
public static final ca.uhn.fhir.rest.gclient.TokenClientParam VERSION
Fluent Client search parameter constant for versionDescription: The business version of the message definition
Type: token
Path: MessageDefinition.version
-
SP_URL
public static final String SP_URL
Search parameter: urlDescription: The uri that identifies the message definition
Type: uri
Path: MessageDefinition.url
- See Also:
- Constant Field Values
-
URL
public static final ca.uhn.fhir.rest.gclient.UriClientParam URL
Fluent Client search parameter constant for urlDescription: The uri that identifies the message definition
Type: uri
Path: MessageDefinition.url
-
SP_NAME
public static final String SP_NAME
Search parameter: nameDescription: Computationally friendly name of the message definition
Type: string
Path: MessageDefinition.name
- See Also:
- Constant Field Values
-
NAME
public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME
Fluent Client search parameter constant for nameDescription: Computationally friendly name of the message definition
Type: string
Path: MessageDefinition.name
-
SP_PUBLISHER
public static final String SP_PUBLISHER
Search parameter: publisherDescription: Name of the publisher of the message definition
Type: string
Path: MessageDefinition.publisher
- See Also:
- Constant Field Values
-
PUBLISHER
public static final ca.uhn.fhir.rest.gclient.StringClientParam PUBLISHER
Fluent Client search parameter constant for publisherDescription: Name of the publisher of the message definition
Type: string
Path: MessageDefinition.publisher
-
SP_EVENT
public static final String SP_EVENT
Search parameter: eventDescription: The event that triggers the message
Type: token
Path: MessageDefinition.event
- See Also:
- Constant Field Values
-
EVENT
public static final ca.uhn.fhir.rest.gclient.TokenClientParam EVENT
Fluent Client search parameter constant for eventDescription: The event that triggers the message
Type: token
Path: MessageDefinition.event
-
SP_CATEGORY
public static final String SP_CATEGORY
Search parameter: categoryDescription: The behavior associated with the message
Type: token
Path: MessageDefinition.category
- See Also:
- Constant Field Values
-
CATEGORY
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CATEGORY
Fluent Client search parameter constant for categoryDescription: The behavior associated with the message
Type: token
Path: MessageDefinition.category
-
SP_STATUS
public static final String SP_STATUS
Search parameter: statusDescription: The current status of the message definition
Type: token
Path: MessageDefinition.status
- See Also:
- Constant Field Values
-
STATUS
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
Fluent Client search parameter constant for statusDescription: The current status of the message definition
Type: token
Path: MessageDefinition.status
-
-
Constructor Detail
-
MessageDefinition
public MessageDefinition()
Constructor
-
MessageDefinition
public MessageDefinition(Enumeration<Enumerations.PublicationStatus> status, DateTimeType date, Coding event)
Constructor
-
-
Method Detail
-
getUrlElement
public UriType getUrlElement()
- Overrides:
getUrlElement
in classMetadataResource
- Returns:
MetadataResource.url
(An absolute URI that is used to identify this message 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 message definition is (or will be) published. The URL SHOULD include the major version of the message 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
public boolean hasUrlElement()
- Overrides:
hasUrlElement
in classMetadataResource
-
hasUrl
public boolean hasUrl()
- Overrides:
hasUrl
in classMetadataResource
-
setUrlElement
public MessageDefinition setUrlElement(UriType value)
- Overrides:
setUrlElement
in classMetadataResource
- Parameters:
value
-MetadataResource.url
(An absolute URI that is used to identify this message 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 message definition is (or will be) published. The URL SHOULD include the major version of the message 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
public String getUrl()
- Overrides:
getUrl
in classMetadataResource
- Returns:
- An absolute URI that is used to identify this message 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 message definition is (or will be) published. The URL SHOULD include the major version of the message definition. For more information see [Technical and Business Versions](resource.html#versions).
-
setUrl
public MessageDefinition setUrl(String value)
- Overrides:
setUrl
in classMetadataResource
- Parameters:
value
- An absolute URI that is used to identify this message 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 message definition is (or will be) published. The URL SHOULD include the major version of the message definition. For more information see [Technical and Business Versions](resource.html#versions).
-
getIdentifier
public Identifier 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.)
-
hasIdentifier
public boolean hasIdentifier()
-
setIdentifier
public MessageDefinition setIdentifier(Identifier value)
- Parameters:
value
-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.)
-
getVersionElement
public StringType 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
public boolean hasVersionElement()
- Overrides:
hasVersionElement
in classMetadataResource
-
hasVersion
public boolean hasVersion()
- Overrides:
hasVersion
in classMetadataResource
-
setVersionElement
public MessageDefinition setVersionElement(StringType value)
- 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
public String 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
public MessageDefinition setVersion(String value)
- 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
public StringType 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
public boolean hasNameElement()
- Overrides:
hasNameElement
in classMetadataResource
-
hasName
public boolean hasName()
- Overrides:
hasName
in classMetadataResource
-
setNameElement
public MessageDefinition setNameElement(StringType value)
- 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
public String 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
public MessageDefinition setName(String value)
- 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
public StringType 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
public boolean hasTitleElement()
- Overrides:
hasTitleElement
in classMetadataResource
-
hasTitle
public boolean hasTitle()
- Overrides:
hasTitle
in classMetadataResource
-
setTitleElement
public MessageDefinition setTitleElement(StringType value)
- 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
public String getTitle()
- Overrides:
getTitle
in classMetadataResource
- Returns:
- A short, descriptive, user-friendly title for the message definition.
-
setTitle
public MessageDefinition setTitle(String value)
- Overrides:
setTitle
in classMetadataResource
- Parameters:
value
- A short, descriptive, user-friendly title for the message definition.
-
getStatusElement
public Enumeration<Enumerations.PublicationStatus> 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
public boolean hasStatusElement()
- Overrides:
hasStatusElement
in classMetadataResource
-
hasStatus
public boolean hasStatus()
- Overrides:
hasStatus
in classMetadataResource
-
setStatusElement
public MessageDefinition setStatusElement(Enumeration<Enumerations.PublicationStatus> value)
- 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
public Enumerations.PublicationStatus getStatus()
- Overrides:
getStatus
in classMetadataResource
- Returns:
- The status of this message definition. Enables tracking the life-cycle of the content.
-
setStatus
public MessageDefinition setStatus(Enumerations.PublicationStatus value)
- Overrides:
setStatus
in classMetadataResource
- Parameters:
value
- The status of this message definition. Enables tracking the life-cycle of the content.
-
getExperimentalElement
public BooleanType 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
public boolean hasExperimentalElement()
- Overrides:
hasExperimentalElement
in classMetadataResource
-
hasExperimental
public boolean hasExperimental()
- Overrides:
hasExperimental
in classMetadataResource
-
setExperimentalElement
public MessageDefinition setExperimentalElement(BooleanType value)
- 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
public boolean 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
public MessageDefinition setExperimental(boolean value)
- 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
public DateTimeType getDateElement()
- Overrides:
getDateElement
in classMetadataResource
- Returns:
MetadataResource.date
(The date (and optionally time) when the message 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 message definition changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
-
hasDateElement
public boolean hasDateElement()
- Overrides:
hasDateElement
in classMetadataResource
-
hasDate
public boolean hasDate()
- Overrides:
hasDate
in classMetadataResource
-
setDateElement
public MessageDefinition setDateElement(DateTimeType value)
- Overrides:
setDateElement
in classMetadataResource
- Parameters:
value
-MetadataResource.date
(The date (and optionally time) when the message 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 message definition changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
-
getDate
public Date getDate()
- Overrides:
getDate
in classMetadataResource
- Returns:
- The date (and optionally time) when the message 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 message definition changes.
-
setDate
public MessageDefinition setDate(Date value)
- Overrides:
setDate
in classMetadataResource
- Parameters:
value
- The date (and optionally time) when the message 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 message definition changes.
-
getPublisherElement
public StringType getPublisherElement()
- Overrides:
getPublisherElement
in classMetadataResource
- Returns:
MetadataResource.publisher
(The name of the individual or organization 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
public boolean hasPublisherElement()
- Overrides:
hasPublisherElement
in classMetadataResource
-
hasPublisher
public boolean hasPublisher()
- Overrides:
hasPublisher
in classMetadataResource
-
setPublisherElement
public MessageDefinition setPublisherElement(StringType value)
- Overrides:
setPublisherElement
in classMetadataResource
- Parameters:
value
-MetadataResource.publisher
(The name of the individual or organization 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
public String getPublisher()
- Overrides:
getPublisher
in classMetadataResource
- Returns:
- The name of the individual or organization that published the message definition.
-
setPublisher
public MessageDefinition setPublisher(String value)
- Overrides:
setPublisher
in classMetadataResource
- Parameters:
value
- The name of the individual or organization that published the message definition.
-
getContact
public List<ContactDetail> getContact()
- Overrides:
getContact
in classMetadataResource
- Returns:
MetadataResource.contact
(Contact details to assist a user in finding and communicating with the publisher.)
-
setContact
public MessageDefinition setContact(List<ContactDetail> theContact)
- Overrides:
setContact
in classMetadataResource
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasContact
public boolean hasContact()
- Overrides:
hasContact
in classMetadataResource
-
addContact
public ContactDetail addContact()
- Overrides:
addContact
in classMetadataResource
-
addContact
public MessageDefinition addContact(ContactDetail t)
- Overrides:
addContact
in classMetadataResource
-
getContactFirstRep
public ContactDetail getContactFirstRep()
- Overrides:
getContactFirstRep
in classMetadataResource
- Returns:
- The first repetition of repeating field
MetadataResource.contact
, creating it if it does not already exist
-
getDescriptionElement
public MarkdownType 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
public boolean hasDescriptionElement()
- Overrides:
hasDescriptionElement
in classMetadataResource
-
hasDescription
public boolean hasDescription()
- Overrides:
hasDescription
in classMetadataResource
-
setDescriptionElement
public MessageDefinition setDescriptionElement(MarkdownType value)
- 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
public String getDescription()
- Overrides:
getDescription
in classMetadataResource
- Returns:
- A free text natural language description of the message definition from a consumer's perspective.
-
setDescription
public MessageDefinition setDescription(String value)
- Overrides:
setDescription
in classMetadataResource
- Parameters:
value
- A free text natural language description of the message definition from a consumer's perspective.
-
getUseContext
public List<UsageContext> 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 message definition instances.)
-
setUseContext
public MessageDefinition setUseContext(List<UsageContext> theUseContext)
- Overrides:
setUseContext
in classMetadataResource
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasUseContext
public boolean hasUseContext()
- Overrides:
hasUseContext
in classMetadataResource
-
addUseContext
public UsageContext addUseContext()
- Overrides:
addUseContext
in classMetadataResource
-
addUseContext
public MessageDefinition addUseContext(UsageContext t)
- Overrides:
addUseContext
in classMetadataResource
-
getUseContextFirstRep
public UsageContext getUseContextFirstRep()
- Overrides:
getUseContextFirstRep
in classMetadataResource
- Returns:
- The first repetition of repeating field
MetadataResource.useContext
, creating it if it does not already exist
-
getJurisdiction
public List<CodeableConcept> getJurisdiction()
- Overrides:
getJurisdiction
in classMetadataResource
- Returns:
MetadataResource.jurisdiction
(A legal or geographic region in which the message definition is intended to be used.)
-
setJurisdiction
public MessageDefinition setJurisdiction(List<CodeableConcept> theJurisdiction)
- Overrides:
setJurisdiction
in classMetadataResource
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasJurisdiction
public boolean hasJurisdiction()
- Overrides:
hasJurisdiction
in classMetadataResource
-
addJurisdiction
public CodeableConcept addJurisdiction()
- Overrides:
addJurisdiction
in classMetadataResource
-
addJurisdiction
public MessageDefinition addJurisdiction(CodeableConcept t)
- Overrides:
addJurisdiction
in classMetadataResource
-
getJurisdictionFirstRep
public CodeableConcept getJurisdictionFirstRep()
- Overrides:
getJurisdictionFirstRep
in classMetadataResource
- Returns:
- The first repetition of repeating field
MetadataResource.jurisdiction
, creating it if it does not already exist
-
getPurposeElement
public MarkdownType getPurposeElement()
- Returns:
purpose
(Explaination 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
public boolean hasPurposeElement()
-
hasPurpose
public boolean hasPurpose()
-
setPurposeElement
public MessageDefinition setPurposeElement(MarkdownType value)
- Parameters:
value
-purpose
(Explaination 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
public String getPurpose()
- Returns:
- Explaination of why this message definition is needed and why it has been designed as it has.
-
setPurpose
public MessageDefinition setPurpose(String value)
- Parameters:
value
- Explaination of why this message definition is needed and why it has been designed as it has.
-
getCopyrightElement
public MarkdownType 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
public boolean hasCopyrightElement()
-
hasCopyright
public boolean hasCopyright()
-
setCopyrightElement
public MessageDefinition setCopyrightElement(MarkdownType value)
- 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
public String 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
public MessageDefinition setCopyright(String value)
- 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.
-
getBase
public Reference getBase()
- Returns:
base
(The MessageDefinition that is the basis for the contents of this resource.)
-
hasBase
public boolean hasBase()
-
setBase
public MessageDefinition setBase(Reference value)
- Parameters:
value
-base
(The MessageDefinition that is the basis for the contents of this resource.)
-
getBaseTarget
public MessageDefinition getBaseTarget()
- Returns:
base
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. (The MessageDefinition that is the basis for the contents of this resource.)
-
setBaseTarget
public MessageDefinition setBaseTarget(MessageDefinition value)
- Parameters:
value
-base
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. (The MessageDefinition that is the basis for the contents of this resource.)
-
getParent
public List<Reference> getParent()
- Returns:
parent
(Identifies a protocol or workflow that this MessageDefinition represents a step in.)
-
setParent
public MessageDefinition setParent(List<Reference> theParent)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasParent
public boolean hasParent()
-
addParent
public MessageDefinition addParent(Reference t)
-
getParentFirstRep
public Reference getParentFirstRep()
- Returns:
- The first repetition of repeating field
parent
, creating it if it does not already exist
-
getParentTarget
@Deprecated public List<Resource> getParentTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getReplaces
public List<Reference> getReplaces()
- Returns:
replaces
(A MessageDefinition that is superseded by this definition.)
-
setReplaces
public MessageDefinition setReplaces(List<Reference> theReplaces)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasReplaces
public boolean hasReplaces()
-
addReplaces
public Reference addReplaces()
-
addReplaces
public MessageDefinition addReplaces(Reference t)
-
getReplacesFirstRep
public Reference getReplacesFirstRep()
- Returns:
- The first repetition of repeating field
replaces
, creating it if it does not already exist
-
getReplacesTarget
@Deprecated public List<MessageDefinition> getReplacesTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
addReplacesTarget
@Deprecated public MessageDefinition addReplacesTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getEvent
public Coding getEvent()
- Returns:
event
(A coded identifier of a supported messaging event.)
-
hasEvent
public boolean hasEvent()
-
setEvent
public MessageDefinition setEvent(Coding value)
- Parameters:
value
-event
(A coded identifier of a supported messaging event.)
-
getCategoryElement
public Enumeration<MessageDefinition.MessageSignificanceCategory> 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
public boolean hasCategoryElement()
-
hasCategory
public boolean 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
public MessageDefinition.MessageSignificanceCategory getCategory()
- Returns:
- The impact of the content of the message.
-
setCategory
public MessageDefinition setCategory(MessageDefinition.MessageSignificanceCategory value)
- Parameters:
value
- The impact of the content of the message.
-
getFocus
public List<MessageDefinition.MessageDefinitionFocusComponent> 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
public MessageDefinition setFocus(List<MessageDefinition.MessageDefinitionFocusComponent> theFocus)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasFocus
public boolean hasFocus()
-
addFocus
public MessageDefinition.MessageDefinitionFocusComponent addFocus()
-
addFocus
public MessageDefinition addFocus(MessageDefinition.MessageDefinitionFocusComponent t)
-
getFocusFirstRep
public MessageDefinition.MessageDefinitionFocusComponent getFocusFirstRep()
- Returns:
- The first repetition of repeating field
focus
, creating it if it does not already exist
-
getResponseRequiredElement
public BooleanType getResponseRequiredElement()
- Returns:
responseRequired
(Indicates whether a response is required for this message.). This is the underlying object with id, value and extensions. The accessor "getResponseRequired" gives direct access to the value
-
hasResponseRequiredElement
public boolean hasResponseRequiredElement()
-
hasResponseRequired
public boolean hasResponseRequired()
-
setResponseRequiredElement
public MessageDefinition setResponseRequiredElement(BooleanType value)
- Parameters:
value
-responseRequired
(Indicates whether a response is required for this message.). This is the underlying object with id, value and extensions. The accessor "getResponseRequired" gives direct access to the value
-
getResponseRequired
public boolean getResponseRequired()
- Returns:
- Indicates whether a response is required for this message.
-
setResponseRequired
public MessageDefinition setResponseRequired(boolean value)
- Parameters:
value
- Indicates whether a response is required for this message.
-
getAllowedResponse
public List<MessageDefinition.MessageDefinitionAllowedResponseComponent> 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
public boolean hasAllowedResponse()
-
addAllowedResponse
public MessageDefinition.MessageDefinitionAllowedResponseComponent addAllowedResponse()
-
addAllowedResponse
public MessageDefinition addAllowedResponse(MessageDefinition.MessageDefinitionAllowedResponseComponent t)
-
getAllowedResponseFirstRep
public MessageDefinition.MessageDefinitionAllowedResponseComponent getAllowedResponseFirstRep()
- Returns:
- The first repetition of repeating field
allowedResponse
, creating it if it does not already exist
-
listChildren
protected void listChildren(List<Property> children)
- 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
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setProperty
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- 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
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChild
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classMetadataResource
-
copy
public MessageDefinition copy()
- Specified by:
copy
in classMetadataResource
-
typedCopy
protected MessageDefinition typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeep
in classMetadataResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallow
in classMetadataResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classMetadataResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceType
in classResource
-
-