public class MessageDefinition extends MetadataResource
| Modifier and Type | Class and Description |
|---|---|
static class |
MessageDefinition.MessageDefinitionAllowedResponseComponent |
static class |
MessageDefinition.MessageDefinitionFocusComponent |
static class |
MessageDefinition.MessageheaderResponseRequest |
static class |
MessageDefinition.MessageheaderResponseRequestEnumFactory |
static class |
MessageDefinition.MessageSignificanceCategory |
static class |
MessageDefinition.MessageSignificanceCategoryEnumFactory |
| Modifier and Type | Field and Description |
|---|---|
protected List<MessageDefinition.MessageDefinitionAllowedResponseComponent> |
allowedResponse
Indicates what types of messages may be sent as an application-level response to this message.
|
protected CanonicalType |
base
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 category
|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
CONTEXT
Fluent Client search parameter constant for context
|
static ca.uhn.fhir.rest.gclient.QuantityClientParam |
CONTEXT_QUANTITY
Fluent Client search parameter constant for context-quantity
|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
CONTEXT_TYPE
Fluent Client search parameter constant for context-type
|
static ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.QuantityClientParam> |
CONTEXT_TYPE_QUANTITY
Fluent Client search parameter constant for context-type-quantity
|
static ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam> |
CONTEXT_TYPE_VALUE
Fluent Client search parameter constant for context-type-value
|
protected 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 date
|
static ca.uhn.fhir.rest.gclient.StringClientParam |
DESCRIPTION
Fluent Client search parameter constant for description
|
protected Type |
event
Event code or link to the EventDefinition.
|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
EVENT
Fluent Client search parameter constant for event
|
protected 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 focus
|
protected List<CanonicalType> |
graph
Canonical reference to a GraphDefinition.
|
protected List<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 identifier
|
static ca.uhn.fhir.model.api.Include |
INCLUDE_PARENT
Constant for fluent queries to be used to add include statements.
|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
JURISDICTION
Fluent Client search parameter constant for jurisdiction
|
static ca.uhn.fhir.rest.gclient.StringClientParam |
NAME
Fluent Client search parameter constant for name
|
protected List<CanonicalType> |
parent
Identifies a protocol or workflow that this MessageDefinition represents a step in.
|
static ca.uhn.fhir.rest.gclient.ReferenceClientParam |
PARENT
Fluent Client search parameter constant for parent
|
static ca.uhn.fhir.rest.gclient.StringClientParam |
PUBLISHER
Fluent Client search parameter constant for publisher
|
protected MarkdownType |
purpose
Explanation of why this message definition is needed and why it has been designed as it has.
|
protected List<CanonicalType> |
replaces
A MessageDefinition that is superseded by this definition.
|
protected Enumeration<MessageDefinition.MessageheaderResponseRequest> |
responseRequired
Declare at a message definition level whether a response is required or only upon error or success, or never.
|
static String |
SP_CATEGORY
Search parameter: category
|
static String |
SP_CONTEXT
Search parameter: context
|
static String |
SP_CONTEXT_QUANTITY
Search parameter: context-quantity
|
static String |
SP_CONTEXT_TYPE
Search parameter: context-type
|
static String |
SP_CONTEXT_TYPE_QUANTITY
Search parameter: context-type-quantity
|
static String |
SP_CONTEXT_TYPE_VALUE
Search parameter: context-type-value
|
static String |
SP_DATE
Search parameter: date
|
static String |
SP_DESCRIPTION
Search parameter: description
|
static String |
SP_EVENT
Search parameter: event
|
static String |
SP_FOCUS
Search parameter: focus
|
static String |
SP_IDENTIFIER
Search parameter: identifier
|
static String |
SP_JURISDICTION
Search parameter: jurisdiction
|
static String |
SP_NAME
Search parameter: name
|
static String |
SP_PARENT
Search parameter: parent
|
static String |
SP_PUBLISHER
Search parameter: publisher
|
static String |
SP_STATUS
Search parameter: status
|
static String |
SP_TITLE
Search parameter: title
|
static String |
SP_URL
Search parameter: url
|
static String |
SP_VERSION
Search parameter: version
|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
STATUS
Fluent Client search parameter constant for status
|
static ca.uhn.fhir.rest.gclient.StringClientParam |
TITLE
Fluent Client search parameter constant for title
|
static ca.uhn.fhir.rest.gclient.UriClientParam |
URL
Fluent Client search parameter constant for url
|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
VERSION
Fluent Client search parameter constant for version
|
contact, date, description, experimental, jurisdiction, name, publisher, status, title, url, useContext, versioncontained, extension, modifierExtension, textid, implicitRules, language, meta| Constructor and Description |
|---|
MessageDefinition()
Constructor
|
MessageDefinition(Enumeration<Enumerations.PublicationStatus> status,
DateTimeType date,
Type event)
Constructor
|
copyValues, present, toStringaddContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setTextcopyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMetagetStructureFhirVersionEnum, isResource, setIdcastToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINNclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitgetId, getIdElement, getLanguageElement, getUserData, setId, setUserDataprotected List<Identifier> identifier
protected List<CanonicalType> replaces
protected MarkdownType purpose
protected MarkdownType copyright
protected CanonicalType base
protected List<CanonicalType> parent
protected Enumeration<MessageDefinition.MessageSignificanceCategory> category
protected List<MessageDefinition.MessageDefinitionFocusComponent> focus
protected Enumeration<MessageDefinition.MessageheaderResponseRequest> responseRequired
protected List<MessageDefinition.MessageDefinitionAllowedResponseComponent> allowedResponse
protected List<CanonicalType> graph
public static final String SP_DATE
Description: The message definition publication date
Type: date
Path: MessageDefinition.date
public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
Description: The message definition publication date
Type: date
Path: MessageDefinition.date
public static final String SP_IDENTIFIER
Description: External identifier for the message definition
Type: token
Path: MessageDefinition.identifier
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
Description: External identifier for the message definition
Type: token
Path: MessageDefinition.identifier
public static final String SP_PARENT
Description: A resource that is the parent of the definition
Type: reference
Path: MessageDefinition.parent
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PARENT
Description: A resource that is the parent of the definition
Type: reference
Path: MessageDefinition.parent
public static final ca.uhn.fhir.model.api.Include INCLUDE_PARENT
public static final String SP_CONTEXT_TYPE_VALUE
Description: A use context type and value assigned to the message definition
Type: composite
Path:
public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam> CONTEXT_TYPE_VALUE
Description: A use context type and value assigned to the message definition
Type: composite
Path:
public static final String SP_JURISDICTION
Description: Intended jurisdiction for the message definition
Type: token
Path: MessageDefinition.jurisdiction
public static final ca.uhn.fhir.rest.gclient.TokenClientParam JURISDICTION
Description: Intended jurisdiction for the message definition
Type: token
Path: MessageDefinition.jurisdiction
public static final String SP_DESCRIPTION
Description: The description of the message definition
Type: string
Path: MessageDefinition.description
public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION
Description: The description of the message definition
Type: string
Path: MessageDefinition.description
public static final String SP_FOCUS
Description: A resource that is a permitted focus of the message
Type: token
Path: MessageDefinition.focus.code
public static final ca.uhn.fhir.rest.gclient.TokenClientParam FOCUS
Description: A resource that is a permitted focus of the message
Type: token
Path: MessageDefinition.focus.code
public static final String SP_CONTEXT_TYPE
Description: A type of use context assigned to the message definition
Type: token
Path: MessageDefinition.useContext.code
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT_TYPE
Description: A type of use context assigned to the message definition
Type: token
Path: MessageDefinition.useContext.code
public static final String SP_TITLE
Description: The human-friendly name of the message definition
Type: string
Path: MessageDefinition.title
public static final ca.uhn.fhir.rest.gclient.StringClientParam TITLE
Description: The human-friendly name of the message definition
Type: string
Path: MessageDefinition.title
public static final String SP_VERSION
Description: The business version of the message definition
Type: token
Path: MessageDefinition.version
public static final ca.uhn.fhir.rest.gclient.TokenClientParam VERSION
Description: The business version of the message definition
Type: token
Path: MessageDefinition.version
public static final String SP_URL
Description: The uri that identifies the message definition
Type: uri
Path: MessageDefinition.url
public static final ca.uhn.fhir.rest.gclient.UriClientParam URL
Description: The uri that identifies the message definition
Type: uri
Path: MessageDefinition.url
public static final String SP_CONTEXT_QUANTITY
Description: A quantity- or range-valued use context assigned to the message definition
Type: quantity
Path: MessageDefinition.useContext.valueQuantity, MessageDefinition.useContext.valueRange
public static final ca.uhn.fhir.rest.gclient.QuantityClientParam CONTEXT_QUANTITY
Description: A quantity- or range-valued use context assigned to the message definition
Type: quantity
Path: MessageDefinition.useContext.valueQuantity, MessageDefinition.useContext.valueRange
public static final String SP_NAME
Description: Computationally friendly name of the message definition
Type: string
Path: MessageDefinition.name
public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME
Description: Computationally friendly name of the message definition
Type: string
Path: MessageDefinition.name
public static final String SP_CONTEXT
Description: A use context assigned to the message definition
Type: token
Path: MessageDefinition.useContext.valueCodeableConcept
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT
Description: A use context assigned to the message definition
Type: token
Path: MessageDefinition.useContext.valueCodeableConcept
public static final String SP_PUBLISHER
Description: Name of the publisher of the message definition
Type: string
Path: MessageDefinition.publisher
public static final ca.uhn.fhir.rest.gclient.StringClientParam PUBLISHER
Description: Name of the publisher of the message definition
Type: string
Path: MessageDefinition.publisher
public static final String SP_EVENT
Description: The event that triggers the message or link to the event definition.
Type: token
Path: MessageDefinition.event[x]
public static final ca.uhn.fhir.rest.gclient.TokenClientParam EVENT
Description: The event that triggers the message or link to the event definition.
Type: token
Path: MessageDefinition.event[x]
public static final String SP_CATEGORY
Description: The behavior associated with the message
Type: token
Path: MessageDefinition.category
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CATEGORY
Description: The behavior associated with the message
Type: token
Path: MessageDefinition.category
public static final String SP_CONTEXT_TYPE_QUANTITY
Description: A use context type and quantity- or range-based value assigned to the message definition
Type: composite
Path:
public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.QuantityClientParam> CONTEXT_TYPE_QUANTITY
Description: A use context type and quantity- or range-based value assigned to the message definition
Type: composite
Path:
public static final String SP_STATUS
Description: The current status of the message definition
Type: token
Path: MessageDefinition.status
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
Description: The current status of the message definition
Type: token
Path: MessageDefinition.status
public MessageDefinition()
public MessageDefinition(Enumeration<Enumerations.PublicationStatus> status, DateTimeType date, Type event)
public UriType getUrlElement()
getUrlElement in class MetadataResourceMetadataResource.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 valuepublic boolean hasUrlElement()
hasUrlElement in class MetadataResourcepublic boolean hasUrl()
hasUrl in class MetadataResourcepublic MessageDefinition setUrlElement(UriType value)
setUrlElement in class MetadataResourcevalue - 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 valuepublic String getUrl()
getUrl in class MetadataResourcepublic MessageDefinition setUrl(String value)
setUrl in class MetadataResourcevalue - The business identifier that is used to reference the MessageDefinition and *is* expected to be consistent from server to server.public List<Identifier> getIdentifier()
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.)public MessageDefinition setIdentifier(List<Identifier> theIdentifier)
this for easy method chainingpublic boolean hasIdentifier()
public Identifier addIdentifier()
public MessageDefinition addIdentifier(Identifier t)
public Identifier getIdentifierFirstRep()
identifier, creating it if it does not already existpublic StringType getVersionElement()
getVersionElement in class MetadataResourceMetadataResource.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 valuepublic boolean hasVersionElement()
hasVersionElement in class MetadataResourcepublic boolean hasVersion()
hasVersion in class MetadataResourcepublic MessageDefinition setVersionElement(StringType value)
setVersionElement in class MetadataResourcevalue - 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 valuepublic String getVersion()
getVersion in class MetadataResourcepublic MessageDefinition setVersion(String value)
setVersion in class MetadataResourcevalue - 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.public StringType getNameElement()
getNameElement in class MetadataResourceMetadataResource.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 valuepublic boolean hasNameElement()
hasNameElement in class MetadataResourcepublic boolean hasName()
hasName in class MetadataResourcepublic MessageDefinition setNameElement(StringType value)
setNameElement in class MetadataResourcevalue - 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 valuepublic String getName()
getName in class MetadataResourcepublic MessageDefinition setName(String value)
setName in class MetadataResourcevalue - 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.public StringType getTitleElement()
getTitleElement in class MetadataResourceMetadataResource.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 valuepublic boolean hasTitleElement()
hasTitleElement in class MetadataResourcepublic boolean hasTitle()
hasTitle in class MetadataResourcepublic MessageDefinition setTitleElement(StringType value)
setTitleElement in class MetadataResourcevalue - 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 valuepublic String getTitle()
getTitle in class MetadataResourcepublic MessageDefinition setTitle(String value)
setTitle in class MetadataResourcevalue - A short, descriptive, user-friendly title for the message definition.public List<CanonicalType> getReplaces()
replaces (A MessageDefinition that is superseded by this definition.)public MessageDefinition setReplaces(List<CanonicalType> theReplaces)
this for easy method chainingpublic boolean hasReplaces()
public CanonicalType addReplacesElement()
replaces (A MessageDefinition that is superseded by this definition.)public MessageDefinition addReplaces(String value)
value - replaces (A MessageDefinition that is superseded by this definition.)public boolean hasReplaces(String value)
value - replaces (A MessageDefinition that is superseded by this definition.)public Enumeration<Enumerations.PublicationStatus> getStatusElement()
getStatusElement in class MetadataResourceMetadataResource.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 valuepublic boolean hasStatusElement()
hasStatusElement in class MetadataResourcepublic boolean hasStatus()
hasStatus in class MetadataResourcepublic MessageDefinition setStatusElement(Enumeration<Enumerations.PublicationStatus> value)
setStatusElement in class MetadataResourcevalue - 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 valuepublic Enumerations.PublicationStatus getStatus()
getStatus in class MetadataResourcepublic MessageDefinition setStatus(Enumerations.PublicationStatus value)
setStatus in class MetadataResourcevalue - The status of this message definition. Enables tracking the life-cycle of the content.public BooleanType getExperimentalElement()
getExperimentalElement in class MetadataResourceMetadataResource.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 valuepublic boolean hasExperimentalElement()
hasExperimentalElement in class MetadataResourcepublic boolean hasExperimental()
hasExperimental in class MetadataResourcepublic MessageDefinition setExperimentalElement(BooleanType value)
setExperimentalElement in class MetadataResourcevalue - 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 valuepublic boolean getExperimental()
getExperimental in class MetadataResourcepublic MessageDefinition setExperimental(boolean value)
setExperimental in class MetadataResourcevalue - 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.public DateTimeType getDateElement()
getDateElement in class MetadataResourceMetadataResource.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 valuepublic boolean hasDateElement()
hasDateElement in class MetadataResourcepublic boolean hasDate()
hasDate in class MetadataResourcepublic MessageDefinition setDateElement(DateTimeType value)
setDateElement in class MetadataResourcevalue - 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 valuepublic Date getDate()
getDate in class MetadataResourcepublic MessageDefinition setDate(Date value)
setDate in class MetadataResourcevalue - 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.public StringType getPublisherElement()
getPublisherElement in class MetadataResourceMetadataResource.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 valuepublic boolean hasPublisherElement()
hasPublisherElement in class MetadataResourcepublic boolean hasPublisher()
hasPublisher in class MetadataResourcepublic MessageDefinition setPublisherElement(StringType value)
setPublisherElement in class MetadataResourcevalue - 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 valuepublic String getPublisher()
getPublisher in class MetadataResourcepublic MessageDefinition setPublisher(String value)
setPublisher in class MetadataResourcevalue - The name of the organization or individual that published the message definition.public List<ContactDetail> getContact()
getContact in class MetadataResourceMetadataResource.contact (Contact details to assist a user in finding and communicating with the publisher.)public MessageDefinition setContact(List<ContactDetail> theContact)
setContact in class MetadataResourcethis for easy method chainingpublic boolean hasContact()
hasContact in class MetadataResourcepublic ContactDetail addContact()
addContact in class MetadataResourcepublic MessageDefinition addContact(ContactDetail t)
addContact in class MetadataResourcepublic ContactDetail getContactFirstRep()
getContactFirstRep in class MetadataResourceMetadataResource.contact, creating it if it does not already existpublic MarkdownType getDescriptionElement()
getDescriptionElement in class MetadataResourceMetadataResource.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 valuepublic boolean hasDescriptionElement()
hasDescriptionElement in class MetadataResourcepublic boolean hasDescription()
hasDescription in class MetadataResourcepublic MessageDefinition setDescriptionElement(MarkdownType value)
setDescriptionElement in class MetadataResourcevalue - 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 valuepublic String getDescription()
getDescription in class MetadataResourcepublic MessageDefinition setDescription(String value)
setDescription in class MetadataResourcevalue - A free text natural language description of the message definition from a consumer's perspective.public List<UsageContext> getUseContext()
getUseContext in class MetadataResourceMetadataResource.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.)public MessageDefinition setUseContext(List<UsageContext> theUseContext)
setUseContext in class MetadataResourcethis for easy method chainingpublic boolean hasUseContext()
hasUseContext in class MetadataResourcepublic UsageContext addUseContext()
addUseContext in class MetadataResourcepublic MessageDefinition addUseContext(UsageContext t)
addUseContext in class MetadataResourcepublic UsageContext getUseContextFirstRep()
getUseContextFirstRep in class MetadataResourceMetadataResource.useContext, creating it if it does not already existpublic List<CodeableConcept> getJurisdiction()
getJurisdiction in class MetadataResourceMetadataResource.jurisdiction (A legal or geographic region in which the message definition is intended to be used.)public MessageDefinition setJurisdiction(List<CodeableConcept> theJurisdiction)
setJurisdiction in class MetadataResourcethis for easy method chainingpublic boolean hasJurisdiction()
hasJurisdiction in class MetadataResourcepublic CodeableConcept addJurisdiction()
addJurisdiction in class MetadataResourcepublic MessageDefinition addJurisdiction(CodeableConcept t)
addJurisdiction in class MetadataResourcepublic CodeableConcept getJurisdictionFirstRep()
getJurisdictionFirstRep in class MetadataResourceMetadataResource.jurisdiction, creating it if it does not already existpublic MarkdownType getPurposeElement()
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 valuepublic boolean hasPurposeElement()
public boolean hasPurpose()
public MessageDefinition setPurposeElement(MarkdownType value)
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 valuepublic String getPurpose()
public MessageDefinition setPurpose(String value)
value - Explanation of why this message definition is needed and why it has been designed as it has.public MarkdownType getCopyrightElement()
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 valuepublic boolean hasCopyrightElement()
public boolean hasCopyright()
public MessageDefinition setCopyrightElement(MarkdownType value)
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 valuepublic String getCopyright()
public MessageDefinition setCopyright(String value)
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.public CanonicalType getBaseElement()
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 valuepublic boolean hasBaseElement()
public boolean hasBase()
public MessageDefinition setBaseElement(CanonicalType value)
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 valuepublic String getBase()
public MessageDefinition setBase(String value)
value - The MessageDefinition that is the basis for the contents of this resource.public List<CanonicalType> getParent()
parent (Identifies a protocol or workflow that this MessageDefinition represents a step in.)public MessageDefinition setParent(List<CanonicalType> theParent)
this for easy method chainingpublic boolean hasParent()
public CanonicalType addParentElement()
parent (Identifies a protocol or workflow that this MessageDefinition represents a step in.)public MessageDefinition addParent(String value)
value - parent (Identifies a protocol or workflow that this MessageDefinition represents a step in.)public boolean hasParent(String value)
value - parent (Identifies a protocol or workflow that this MessageDefinition represents a step in.)public Coding getEventCoding() throws org.hl7.fhir.exceptions.FHIRException
event (Event code or link to the EventDefinition.)org.hl7.fhir.exceptions.FHIRExceptionpublic boolean hasEventCoding()
public UriType getEventUriType() throws org.hl7.fhir.exceptions.FHIRException
event (Event code or link to the EventDefinition.)org.hl7.fhir.exceptions.FHIRExceptionpublic boolean hasEventUriType()
public boolean hasEvent()
public MessageDefinition setEvent(Type value)
value - event (Event code or link to the EventDefinition.)public Enumeration<MessageDefinition.MessageSignificanceCategory> getCategoryElement()
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 valuepublic boolean hasCategoryElement()
public boolean hasCategory()
public MessageDefinition setCategoryElement(Enumeration<MessageDefinition.MessageSignificanceCategory> value)
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 valuepublic MessageDefinition.MessageSignificanceCategory getCategory()
public MessageDefinition setCategory(MessageDefinition.MessageSignificanceCategory value)
value - The impact of the content of the message.public List<MessageDefinition.MessageDefinitionFocusComponent> getFocus()
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.)public MessageDefinition setFocus(List<MessageDefinition.MessageDefinitionFocusComponent> theFocus)
this for easy method chainingpublic boolean hasFocus()
public MessageDefinition.MessageDefinitionFocusComponent addFocus()
public MessageDefinition addFocus(MessageDefinition.MessageDefinitionFocusComponent t)
public MessageDefinition.MessageDefinitionFocusComponent getFocusFirstRep()
focus, creating it if it does not already existpublic Enumeration<MessageDefinition.MessageheaderResponseRequest> getResponseRequiredElement()
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 valuepublic boolean hasResponseRequiredElement()
public boolean hasResponseRequired()
public MessageDefinition setResponseRequiredElement(Enumeration<MessageDefinition.MessageheaderResponseRequest> value)
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 valuepublic MessageDefinition.MessageheaderResponseRequest getResponseRequired()
public MessageDefinition setResponseRequired(MessageDefinition.MessageheaderResponseRequest value)
value - Declare at a message definition level whether a response is required or only upon error or success, or never.public List<MessageDefinition.MessageDefinitionAllowedResponseComponent> getAllowedResponse()
allowedResponse (Indicates what types of messages may be sent as an application-level response to this message.)public MessageDefinition setAllowedResponse(List<MessageDefinition.MessageDefinitionAllowedResponseComponent> theAllowedResponse)
this for easy method chainingpublic boolean hasAllowedResponse()
public MessageDefinition.MessageDefinitionAllowedResponseComponent addAllowedResponse()
public MessageDefinition addAllowedResponse(MessageDefinition.MessageDefinitionAllowedResponseComponent t)
public MessageDefinition.MessageDefinitionAllowedResponseComponent getAllowedResponseFirstRep()
allowedResponse, creating it if it does not already existpublic List<CanonicalType> getGraph()
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.)public MessageDefinition setGraph(List<CanonicalType> theGraph)
this for easy method chainingpublic boolean hasGraph()
public CanonicalType addGraphElement()
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.)public MessageDefinition addGraph(String value)
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.)public boolean hasGraph(String value)
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.)protected void listChildren(List<Property> children)
listChildren in class MetadataResourcepublic Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
getNamedProperty in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
getProperty in class MetadataResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
setProperty in class MetadataResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
setProperty in class MetadataResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
makeProperty in class MetadataResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
getTypesForProperty in class MetadataResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
addChild in class MetadataResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic String fhirType()
fhirType in interface org.hl7.fhir.instance.model.api.IBasefhirType in class MetadataResourcepublic MessageDefinition copy()
copy in class MetadataResourcepublic void copyValues(MessageDefinition dst)
protected MessageDefinition typedCopy()
public boolean equalsDeep(Base other_)
equalsDeep in class MetadataResourcepublic boolean equalsShallow(Base other_)
equalsShallow in class MetadataResourcepublic boolean isEmpty()
isEmpty in interface org.hl7.fhir.instance.model.api.IBaseisEmpty in class MetadataResourcepublic ResourceType getResourceType()
getResourceType in class ResourceCopyright © 2014–2021 Health Level 7. All rights reserved.