Class MessageDefinition
- java.lang.Object
-
- org.hl7.fhir.r4b.model.Base
-
- org.hl7.fhir.r4b.model.BaseResource
-
- org.hl7.fhir.r4b.model.Resource
-
- org.hl7.fhir.r4b.model.DomainResource
-
- org.hl7.fhir.r4b.model.CanonicalResource
-
- org.hl7.fhir.r4b.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 CanonicalResource
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 classMessageDefinition.MessageDefinitionAllowedResponseComponentstatic classMessageDefinition.MessageDefinitionFocusComponentstatic classMessageDefinition.MessageheaderResponseRequeststatic classMessageDefinition.MessageheaderResponseRequestEnumFactorystatic classMessageDefinition.MessageSignificanceCategorystatic classMessageDefinition.MessageSignificanceCategoryEnumFactory
-
Field Summary
Fields Modifier and Type Field Description protected List<MessageDefinition.MessageDefinitionAllowedResponseComponent>allowedResponseIndicates what types of messages may be sent as an application-level response to this message.protected CanonicalTypebaseThe MessageDefinition that is the basis for the contents of this resource.protected Enumeration<MessageDefinition.MessageSignificanceCategory>categoryThe impact of the content of the message.static ca.uhn.fhir.rest.gclient.TokenClientParamCATEGORYFluent Client search parameter constant for categoryprotected List<ContactDetail>contactContact details to assist a user in finding and communicating with the publisher.static ca.uhn.fhir.rest.gclient.TokenClientParamCONTEXTFluent Client search parameter constant for contextstatic ca.uhn.fhir.rest.gclient.QuantityClientParamCONTEXT_QUANTITYFluent Client search parameter constant for context-quantitystatic ca.uhn.fhir.rest.gclient.TokenClientParamCONTEXT_TYPEFluent Client search parameter constant for context-typestatic 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-quantitystatic 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-valueprotected MarkdownTypecopyrightA copyright statement relating to the message definition and/or its contents.protected DateTimeTypedateThe date (and optionally time) when the message definition was published.static ca.uhn.fhir.rest.gclient.DateClientParamDATEFluent Client search parameter constant for dateprotected MarkdownTypedescriptionA free text natural language description of the message definition from a consumer's perspective.static ca.uhn.fhir.rest.gclient.StringClientParamDESCRIPTIONFluent Client search parameter constant for descriptionprotected DataTypeeventEvent code or link to the EventDefinition.static ca.uhn.fhir.rest.gclient.TokenClientParamEVENTFluent Client search parameter constant for eventprotected BooleanTypeexperimentalA 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.protected List<MessageDefinition.MessageDefinitionFocusComponent>focusIdentifies the resource (or resources) that are being addressed by the event.static ca.uhn.fhir.rest.gclient.TokenClientParamFOCUSFluent Client search parameter constant for focusprotected List<CanonicalType>graphCanonical reference to a GraphDefinition.protected List<Identifier>identifierA 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.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.IncludeINCLUDE_PARENTConstant for fluent queries to be used to add include statements.protected List<CodeableConcept>jurisdictionA legal or geographic region in which the message definition is intended to be used.static ca.uhn.fhir.rest.gclient.TokenClientParamJURISDICTIONFluent Client search parameter constant for jurisdictionprotected StringTypenameA natural language name identifying the message definition.static ca.uhn.fhir.rest.gclient.StringClientParamNAMEFluent Client search parameter constant for nameprotected List<CanonicalType>parentIdentifies a protocol or workflow that this MessageDefinition represents a step in.static ca.uhn.fhir.rest.gclient.ReferenceClientParamPARENTFluent Client search parameter constant for parentprotected StringTypepublisherThe name of the organization or individual that published the message definition.static ca.uhn.fhir.rest.gclient.StringClientParamPUBLISHERFluent Client search parameter constant for publisherprotected MarkdownTypepurposeExplanation of why this message definition is needed and why it has been designed as it has.protected List<CanonicalType>replacesA MessageDefinition that is superseded by this definition.protected Enumeration<MessageDefinition.MessageheaderResponseRequest>responseRequiredDeclare at a message definition level whether a response is required or only upon error or success, or never.static StringSP_CATEGORYSearch parameter: categorystatic StringSP_CONTEXTSearch parameter: contextstatic StringSP_CONTEXT_QUANTITYSearch parameter: context-quantitystatic StringSP_CONTEXT_TYPESearch parameter: context-typestatic StringSP_CONTEXT_TYPE_QUANTITYSearch parameter: context-type-quantitystatic StringSP_CONTEXT_TYPE_VALUESearch parameter: context-type-valuestatic StringSP_DATESearch parameter: datestatic StringSP_DESCRIPTIONSearch parameter: descriptionstatic StringSP_EVENTSearch parameter: eventstatic StringSP_FOCUSSearch parameter: focusstatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_JURISDICTIONSearch parameter: jurisdictionstatic StringSP_NAMESearch parameter: namestatic StringSP_PARENTSearch parameter: parentstatic StringSP_PUBLISHERSearch parameter: publisherstatic StringSP_STATUSSearch parameter: statusstatic StringSP_TITLESearch parameter: titlestatic StringSP_URLSearch parameter: urlstatic StringSP_VERSIONSearch parameter: versionprotected Enumeration<Enumerations.PublicationStatus>statusThe status of this message definition.static ca.uhn.fhir.rest.gclient.TokenClientParamSTATUSFluent Client search parameter constant for statusprotected StringTypetitleA short, descriptive, user-friendly title for the message definition.static ca.uhn.fhir.rest.gclient.StringClientParamTITLEFluent Client search parameter constant for titleprotected UriTypeurlThe business identifier that is used to reference the MessageDefinition and *is* expected to be consistent from server to server.static ca.uhn.fhir.rest.gclient.UriClientParamURLFluent Client search parameter constant for urlprotected List<UsageContext>useContextThe content was developed with a focus and intent of supporting the contexts that are listed.protected StringTypeversionThe identifier that is used to identify this version of the message definition when it is referenced in a specification, model, design or instance.static ca.uhn.fhir.rest.gclient.TokenClientParamVERSIONFluent Client search parameter constant for version-
Fields inherited from class org.hl7.fhir.r4b.model.DomainResource
contained, extension, modifierExtension, SP_TEXT, text, TEXT
-
Fields inherited from class org.hl7.fhir.r4b.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description MessageDefinition()ConstructorMessageDefinition(Enumerations.PublicationStatus status, Date date, DataType event)Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r4b.model.CanonicalResource
copyValues, getContactMax, getCopyrightMax, getDateMax, getDescriptionMax, getExperimentalMax, getIdentifierMax, getJurisdictionMax, getNameMax, getPublisherMax, getPurposeMax, getStatusMax, getTitleMax, getUrlMax, getUseContextMax, getVersionedUrl, getVersionMax, getVUrl, present, supportsCopyright, toString
-
Methods inherited from class org.hl7.fhir.r4b.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.r4b.model.Resource
copyValues, getId, getIdBase, getIdElement, 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.r4b.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.r4b.model.Base
children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyUserData, 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
-
-
-
-
Field Detail
-
url
protected UriType url
The business identifier that is used to reference the MessageDefinition and *is* expected to be consistent from server to server.
-
identifier
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.
-
version
protected StringType 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.
-
name
protected StringType 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.
-
title
protected StringType title
A short, descriptive, user-friendly title for the message definition.
-
replaces
protected List<CanonicalType> replaces
A MessageDefinition that is superseded by this definition.
-
status
protected Enumeration<Enumerations.PublicationStatus> status
The status of this message definition. Enables tracking the life-cycle of the content.
-
experimental
protected BooleanType 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.
-
date
protected DateTimeType 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.
-
publisher
protected StringType publisher
The name of the organization or individual that published the message definition.
-
contact
protected List<ContactDetail> contact
Contact details to assist a user in finding and communicating with the publisher.
-
description
protected MarkdownType description
A free text natural language description of the message definition from a consumer's perspective.
-
useContext
protected List<UsageContext> 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.
-
jurisdiction
protected List<CodeableConcept> jurisdiction
A legal or geographic region in which the message definition is intended to be used.
-
purpose
protected MarkdownType purpose
Explanation 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 CanonicalType base
The MessageDefinition that is the basis for the contents of this resource.
-
parent
protected List<CanonicalType> parent
Identifies a protocol or workflow that this MessageDefinition represents a step in.
-
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 Enumeration<MessageDefinition.MessageheaderResponseRequest> responseRequired
Declare at a message definition level whether a response is required or only upon error or success, or never.
-
allowedResponse
protected List<MessageDefinition.MessageDefinitionAllowedResponseComponent> allowedResponse
Indicates what types of messages may be sent as an application-level response to this message.
-
graph
protected List<CanonicalType> graph
Canonical reference to a GraphDefinition. If a URL is provided, it is the canonical reference to a [GraphDefinition](graphdefinition.html) 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_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_EVENT
public static final String SP_EVENT
Search parameter: eventDescription: The event that triggers the message or link to the event definition.
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 or link to the event definition.
Type: token
Path: MessageDefinition.event
-
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_PARENT
public static final String SP_PARENT
Search parameter: parentDescription: A resource that is the parent of the definition
Type: reference
Path: MessageDefinition.parent
- See Also:
- Constant Field Values
-
PARENT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PARENT
Fluent Client search parameter constant for parentDescription: A resource that is the parent of the definition
Type: reference
Path: MessageDefinition.parent
-
INCLUDE_PARENT
public static final ca.uhn.fhir.model.api.Include INCLUDE_PARENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "MessageDefinition:parent".
-
SP_CONTEXT_QUANTITY
public static final String SP_CONTEXT_QUANTITY
Search parameter: context-quantityDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): A quantity- or range-valued use context assigned to the capability statement [CodeSystem](codesystem.html): A quantity- or range-valued use context assigned to the code system [CompartmentDefinition](compartmentdefinition.html): A quantity- or range-valued use context assigned to the compartment definition [ConceptMap](conceptmap.html): A quantity- or range-valued use context assigned to the concept map [GraphDefinition](graphdefinition.html): A quantity- or range-valued use context assigned to the graph definition [ImplementationGuide](implementationguide.html): A quantity- or range-valued use context assigned to the implementation guide [MessageDefinition](messagedefinition.html): A quantity- or range-valued use context assigned to the message definition [NamingSystem](namingsystem.html): A quantity- or range-valued use context assigned to the naming system [OperationDefinition](operationdefinition.html): A quantity- or range-valued use context assigned to the operation definition [SearchParameter](searchparameter.html): A quantity- or range-valued use context assigned to the search parameter [StructureDefinition](structuredefinition.html): A quantity- or range-valued use context assigned to the structure definition [StructureMap](structuremap.html): A quantity- or range-valued use context assigned to the structure map [TerminologyCapabilities](terminologycapabilities.html): A quantity- or range-valued use context assigned to the terminology capabilities [ValueSet](valueset.html): A quantity- or range-valued use context assigned to the value set
Type: quantity
Path: (CapabilityStatement.useContext.value as Quantity) | (CapabilityStatement.useContext.value as Range) | (CodeSystem.useContext.value as Quantity) | (CodeSystem.useContext.value as Range) | (CompartmentDefinition.useContext.value as Quantity) | (CompartmentDefinition.useContext.value as Range) | (ConceptMap.useContext.value as Quantity) | (ConceptMap.useContext.value as Range) | (GraphDefinition.useContext.value as Quantity) | (GraphDefinition.useContext.value as Range) | (ImplementationGuide.useContext.value as Quantity) | (ImplementationGuide.useContext.value as Range) | (MessageDefinition.useContext.value as Quantity) | (MessageDefinition.useContext.value as Range) | (NamingSystem.useContext.value as Quantity) | (NamingSystem.useContext.value as Range) | (OperationDefinition.useContext.value as Quantity) | (OperationDefinition.useContext.value as Range) | (SearchParameter.useContext.value as Quantity) | (SearchParameter.useContext.value as Range) | (StructureDefinition.useContext.value as Quantity) | (StructureDefinition.useContext.value as Range) | (StructureMap.useContext.value as Quantity) | (StructureMap.useContext.value as Range) | (TerminologyCapabilities.useContext.value as Quantity) | (TerminologyCapabilities.useContext.value as Range) | (ValueSet.useContext.value as Quantity) | (ValueSet.useContext.value as Range)
- See Also:
- Constant Field Values
-
CONTEXT_QUANTITY
public static final ca.uhn.fhir.rest.gclient.QuantityClientParam CONTEXT_QUANTITY
Fluent Client search parameter constant for context-quantityDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): A quantity- or range-valued use context assigned to the capability statement [CodeSystem](codesystem.html): A quantity- or range-valued use context assigned to the code system [CompartmentDefinition](compartmentdefinition.html): A quantity- or range-valued use context assigned to the compartment definition [ConceptMap](conceptmap.html): A quantity- or range-valued use context assigned to the concept map [GraphDefinition](graphdefinition.html): A quantity- or range-valued use context assigned to the graph definition [ImplementationGuide](implementationguide.html): A quantity- or range-valued use context assigned to the implementation guide [MessageDefinition](messagedefinition.html): A quantity- or range-valued use context assigned to the message definition [NamingSystem](namingsystem.html): A quantity- or range-valued use context assigned to the naming system [OperationDefinition](operationdefinition.html): A quantity- or range-valued use context assigned to the operation definition [SearchParameter](searchparameter.html): A quantity- or range-valued use context assigned to the search parameter [StructureDefinition](structuredefinition.html): A quantity- or range-valued use context assigned to the structure definition [StructureMap](structuremap.html): A quantity- or range-valued use context assigned to the structure map [TerminologyCapabilities](terminologycapabilities.html): A quantity- or range-valued use context assigned to the terminology capabilities [ValueSet](valueset.html): A quantity- or range-valued use context assigned to the value set
Type: quantity
Path: (CapabilityStatement.useContext.value as Quantity) | (CapabilityStatement.useContext.value as Range) | (CodeSystem.useContext.value as Quantity) | (CodeSystem.useContext.value as Range) | (CompartmentDefinition.useContext.value as Quantity) | (CompartmentDefinition.useContext.value as Range) | (ConceptMap.useContext.value as Quantity) | (ConceptMap.useContext.value as Range) | (GraphDefinition.useContext.value as Quantity) | (GraphDefinition.useContext.value as Range) | (ImplementationGuide.useContext.value as Quantity) | (ImplementationGuide.useContext.value as Range) | (MessageDefinition.useContext.value as Quantity) | (MessageDefinition.useContext.value as Range) | (NamingSystem.useContext.value as Quantity) | (NamingSystem.useContext.value as Range) | (OperationDefinition.useContext.value as Quantity) | (OperationDefinition.useContext.value as Range) | (SearchParameter.useContext.value as Quantity) | (SearchParameter.useContext.value as Range) | (StructureDefinition.useContext.value as Quantity) | (StructureDefinition.useContext.value as Range) | (StructureMap.useContext.value as Quantity) | (StructureMap.useContext.value as Range) | (TerminologyCapabilities.useContext.value as Quantity) | (TerminologyCapabilities.useContext.value as Range) | (ValueSet.useContext.value as Quantity) | (ValueSet.useContext.value as Range)
-
SP_CONTEXT_TYPE_QUANTITY
public static final String SP_CONTEXT_TYPE_QUANTITY
Search parameter: context-type-quantityDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): A use context type and quantity- or range-based value assigned to the capability statement [CodeSystem](codesystem.html): A use context type and quantity- or range-based value assigned to the code system [CompartmentDefinition](compartmentdefinition.html): A use context type and quantity- or range-based value assigned to the compartment definition [ConceptMap](conceptmap.html): A use context type and quantity- or range-based value assigned to the concept map [GraphDefinition](graphdefinition.html): A use context type and quantity- or range-based value assigned to the graph definition [ImplementationGuide](implementationguide.html): A use context type and quantity- or range-based value assigned to the implementation guide [MessageDefinition](messagedefinition.html): A use context type and quantity- or range-based value assigned to the message definition [NamingSystem](namingsystem.html): A use context type and quantity- or range-based value assigned to the naming system [OperationDefinition](operationdefinition.html): A use context type and quantity- or range-based value assigned to the operation definition [SearchParameter](searchparameter.html): A use context type and quantity- or range-based value assigned to the search parameter [StructureDefinition](structuredefinition.html): A use context type and quantity- or range-based value assigned to the structure definition [StructureMap](structuremap.html): A use context type and quantity- or range-based value assigned to the structure map [TerminologyCapabilities](terminologycapabilities.html): A use context type and quantity- or range-based value assigned to the terminology capabilities [ValueSet](valueset.html): A use context type and quantity- or range-based value assigned to the value set
Type: composite
Path: CapabilityStatement.useContext | CodeSystem.useContext | CompartmentDefinition.useContext | ConceptMap.useContext | GraphDefinition.useContext | ImplementationGuide.useContext | MessageDefinition.useContext | NamingSystem.useContext | OperationDefinition.useContext | SearchParameter.useContext | StructureDefinition.useContext | StructureMap.useContext | TerminologyCapabilities.useContext | ValueSet.useContext
- See Also:
- Constant Field Values
-
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_QUANTITY
Fluent Client search parameter constant for context-type-quantityDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): A use context type and quantity- or range-based value assigned to the capability statement [CodeSystem](codesystem.html): A use context type and quantity- or range-based value assigned to the code system [CompartmentDefinition](compartmentdefinition.html): A use context type and quantity- or range-based value assigned to the compartment definition [ConceptMap](conceptmap.html): A use context type and quantity- or range-based value assigned to the concept map [GraphDefinition](graphdefinition.html): A use context type and quantity- or range-based value assigned to the graph definition [ImplementationGuide](implementationguide.html): A use context type and quantity- or range-based value assigned to the implementation guide [MessageDefinition](messagedefinition.html): A use context type and quantity- or range-based value assigned to the message definition [NamingSystem](namingsystem.html): A use context type and quantity- or range-based value assigned to the naming system [OperationDefinition](operationdefinition.html): A use context type and quantity- or range-based value assigned to the operation definition [SearchParameter](searchparameter.html): A use context type and quantity- or range-based value assigned to the search parameter [StructureDefinition](structuredefinition.html): A use context type and quantity- or range-based value assigned to the structure definition [StructureMap](structuremap.html): A use context type and quantity- or range-based value assigned to the structure map [TerminologyCapabilities](terminologycapabilities.html): A use context type and quantity- or range-based value assigned to the terminology capabilities [ValueSet](valueset.html): A use context type and quantity- or range-based value assigned to the value set
Type: composite
Path: CapabilityStatement.useContext | CodeSystem.useContext | CompartmentDefinition.useContext | ConceptMap.useContext | GraphDefinition.useContext | ImplementationGuide.useContext | MessageDefinition.useContext | NamingSystem.useContext | OperationDefinition.useContext | SearchParameter.useContext | StructureDefinition.useContext | StructureMap.useContext | TerminologyCapabilities.useContext | ValueSet.useContext
-
SP_CONTEXT_TYPE_VALUE
public static final String SP_CONTEXT_TYPE_VALUE
Search parameter: context-type-valueDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): A use context type and value assigned to the capability statement [CodeSystem](codesystem.html): A use context type and value assigned to the code system [CompartmentDefinition](compartmentdefinition.html): A use context type and value assigned to the compartment definition [ConceptMap](conceptmap.html): A use context type and value assigned to the concept map [GraphDefinition](graphdefinition.html): A use context type and value assigned to the graph definition [ImplementationGuide](implementationguide.html): A use context type and value assigned to the implementation guide [MessageDefinition](messagedefinition.html): A use context type and value assigned to the message definition [NamingSystem](namingsystem.html): A use context type and value assigned to the naming system [OperationDefinition](operationdefinition.html): A use context type and value assigned to the operation definition [SearchParameter](searchparameter.html): A use context type and value assigned to the search parameter [StructureDefinition](structuredefinition.html): A use context type and value assigned to the structure definition [StructureMap](structuremap.html): A use context type and value assigned to the structure map [TerminologyCapabilities](terminologycapabilities.html): A use context type and value assigned to the terminology capabilities [ValueSet](valueset.html): A use context type and value assigned to the value set
Type: composite
Path: CapabilityStatement.useContext | CodeSystem.useContext | CompartmentDefinition.useContext | ConceptMap.useContext | GraphDefinition.useContext | ImplementationGuide.useContext | MessageDefinition.useContext | NamingSystem.useContext | OperationDefinition.useContext | SearchParameter.useContext | StructureDefinition.useContext | StructureMap.useContext | TerminologyCapabilities.useContext | ValueSet.useContext
- See Also:
- Constant Field Values
-
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_VALUE
Fluent Client search parameter constant for context-type-valueDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): A use context type and value assigned to the capability statement [CodeSystem](codesystem.html): A use context type and value assigned to the code system [CompartmentDefinition](compartmentdefinition.html): A use context type and value assigned to the compartment definition [ConceptMap](conceptmap.html): A use context type and value assigned to the concept map [GraphDefinition](graphdefinition.html): A use context type and value assigned to the graph definition [ImplementationGuide](implementationguide.html): A use context type and value assigned to the implementation guide [MessageDefinition](messagedefinition.html): A use context type and value assigned to the message definition [NamingSystem](namingsystem.html): A use context type and value assigned to the naming system [OperationDefinition](operationdefinition.html): A use context type and value assigned to the operation definition [SearchParameter](searchparameter.html): A use context type and value assigned to the search parameter [StructureDefinition](structuredefinition.html): A use context type and value assigned to the structure definition [StructureMap](structuremap.html): A use context type and value assigned to the structure map [TerminologyCapabilities](terminologycapabilities.html): A use context type and value assigned to the terminology capabilities [ValueSet](valueset.html): A use context type and value assigned to the value set
Type: composite
Path: CapabilityStatement.useContext | CodeSystem.useContext | CompartmentDefinition.useContext | ConceptMap.useContext | GraphDefinition.useContext | ImplementationGuide.useContext | MessageDefinition.useContext | NamingSystem.useContext | OperationDefinition.useContext | SearchParameter.useContext | StructureDefinition.useContext | StructureMap.useContext | TerminologyCapabilities.useContext | ValueSet.useContext
-
SP_CONTEXT_TYPE
public static final String SP_CONTEXT_TYPE
Search parameter: context-typeDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): A type of use context assigned to the capability statement [CodeSystem](codesystem.html): A type of use context assigned to the code system [CompartmentDefinition](compartmentdefinition.html): A type of use context assigned to the compartment definition [ConceptMap](conceptmap.html): A type of use context assigned to the concept map [GraphDefinition](graphdefinition.html): A type of use context assigned to the graph definition [ImplementationGuide](implementationguide.html): A type of use context assigned to the implementation guide [MessageDefinition](messagedefinition.html): A type of use context assigned to the message definition [NamingSystem](namingsystem.html): A type of use context assigned to the naming system [OperationDefinition](operationdefinition.html): A type of use context assigned to the operation definition [SearchParameter](searchparameter.html): A type of use context assigned to the search parameter [StructureDefinition](structuredefinition.html): A type of use context assigned to the structure definition [StructureMap](structuremap.html): A type of use context assigned to the structure map [TerminologyCapabilities](terminologycapabilities.html): A type of use context assigned to the terminology capabilities [ValueSet](valueset.html): A type of use context assigned to the value set
Type: token
Path: CapabilityStatement.useContext.code | CodeSystem.useContext.code | CompartmentDefinition.useContext.code | ConceptMap.useContext.code | GraphDefinition.useContext.code | ImplementationGuide.useContext.code | MessageDefinition.useContext.code | NamingSystem.useContext.code | OperationDefinition.useContext.code | SearchParameter.useContext.code | StructureDefinition.useContext.code | StructureMap.useContext.code | TerminologyCapabilities.useContext.code | ValueSet.useContext.code
- See Also:
- Constant Field Values
-
CONTEXT_TYPE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT_TYPE
Fluent Client search parameter constant for context-typeDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): A type of use context assigned to the capability statement [CodeSystem](codesystem.html): A type of use context assigned to the code system [CompartmentDefinition](compartmentdefinition.html): A type of use context assigned to the compartment definition [ConceptMap](conceptmap.html): A type of use context assigned to the concept map [GraphDefinition](graphdefinition.html): A type of use context assigned to the graph definition [ImplementationGuide](implementationguide.html): A type of use context assigned to the implementation guide [MessageDefinition](messagedefinition.html): A type of use context assigned to the message definition [NamingSystem](namingsystem.html): A type of use context assigned to the naming system [OperationDefinition](operationdefinition.html): A type of use context assigned to the operation definition [SearchParameter](searchparameter.html): A type of use context assigned to the search parameter [StructureDefinition](structuredefinition.html): A type of use context assigned to the structure definition [StructureMap](structuremap.html): A type of use context assigned to the structure map [TerminologyCapabilities](terminologycapabilities.html): A type of use context assigned to the terminology capabilities [ValueSet](valueset.html): A type of use context assigned to the value set
Type: token
Path: CapabilityStatement.useContext.code | CodeSystem.useContext.code | CompartmentDefinition.useContext.code | ConceptMap.useContext.code | GraphDefinition.useContext.code | ImplementationGuide.useContext.code | MessageDefinition.useContext.code | NamingSystem.useContext.code | OperationDefinition.useContext.code | SearchParameter.useContext.code | StructureDefinition.useContext.code | StructureMap.useContext.code | TerminologyCapabilities.useContext.code | ValueSet.useContext.code
-
SP_CONTEXT
public static final String SP_CONTEXT
Search parameter: contextDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): A use context assigned to the capability statement [CodeSystem](codesystem.html): A use context assigned to the code system [CompartmentDefinition](compartmentdefinition.html): A use context assigned to the compartment definition [ConceptMap](conceptmap.html): A use context assigned to the concept map [GraphDefinition](graphdefinition.html): A use context assigned to the graph definition [ImplementationGuide](implementationguide.html): A use context assigned to the implementation guide [MessageDefinition](messagedefinition.html): A use context assigned to the message definition [NamingSystem](namingsystem.html): A use context assigned to the naming system [OperationDefinition](operationdefinition.html): A use context assigned to the operation definition [SearchParameter](searchparameter.html): A use context assigned to the search parameter [StructureDefinition](structuredefinition.html): A use context assigned to the structure definition [StructureMap](structuremap.html): A use context assigned to the structure map [TerminologyCapabilities](terminologycapabilities.html): A use context assigned to the terminology capabilities [ValueSet](valueset.html): A use context assigned to the value set
Type: token
Path: (CapabilityStatement.useContext.value as CodeableConcept) | (CodeSystem.useContext.value as CodeableConcept) | (CompartmentDefinition.useContext.value as CodeableConcept) | (ConceptMap.useContext.value as CodeableConcept) | (GraphDefinition.useContext.value as CodeableConcept) | (ImplementationGuide.useContext.value as CodeableConcept) | (MessageDefinition.useContext.value as CodeableConcept) | (NamingSystem.useContext.value as CodeableConcept) | (OperationDefinition.useContext.value as CodeableConcept) | (SearchParameter.useContext.value as CodeableConcept) | (StructureDefinition.useContext.value as CodeableConcept) | (StructureMap.useContext.value as CodeableConcept) | (TerminologyCapabilities.useContext.value as CodeableConcept) | (ValueSet.useContext.value as CodeableConcept)
- See Also:
- Constant Field Values
-
CONTEXT
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT
Fluent Client search parameter constant for contextDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): A use context assigned to the capability statement [CodeSystem](codesystem.html): A use context assigned to the code system [CompartmentDefinition](compartmentdefinition.html): A use context assigned to the compartment definition [ConceptMap](conceptmap.html): A use context assigned to the concept map [GraphDefinition](graphdefinition.html): A use context assigned to the graph definition [ImplementationGuide](implementationguide.html): A use context assigned to the implementation guide [MessageDefinition](messagedefinition.html): A use context assigned to the message definition [NamingSystem](namingsystem.html): A use context assigned to the naming system [OperationDefinition](operationdefinition.html): A use context assigned to the operation definition [SearchParameter](searchparameter.html): A use context assigned to the search parameter [StructureDefinition](structuredefinition.html): A use context assigned to the structure definition [StructureMap](structuremap.html): A use context assigned to the structure map [TerminologyCapabilities](terminologycapabilities.html): A use context assigned to the terminology capabilities [ValueSet](valueset.html): A use context assigned to the value set
Type: token
Path: (CapabilityStatement.useContext.value as CodeableConcept) | (CodeSystem.useContext.value as CodeableConcept) | (CompartmentDefinition.useContext.value as CodeableConcept) | (ConceptMap.useContext.value as CodeableConcept) | (GraphDefinition.useContext.value as CodeableConcept) | (ImplementationGuide.useContext.value as CodeableConcept) | (MessageDefinition.useContext.value as CodeableConcept) | (NamingSystem.useContext.value as CodeableConcept) | (OperationDefinition.useContext.value as CodeableConcept) | (SearchParameter.useContext.value as CodeableConcept) | (StructureDefinition.useContext.value as CodeableConcept) | (StructureMap.useContext.value as CodeableConcept) | (TerminologyCapabilities.useContext.value as CodeableConcept) | (ValueSet.useContext.value as CodeableConcept)
-
SP_DATE
public static final String SP_DATE
Search parameter: dateDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): The capability statement publication date [CodeSystem](codesystem.html): The code system publication date [CompartmentDefinition](compartmentdefinition.html): The compartment definition publication date [ConceptMap](conceptmap.html): The concept map publication date [GraphDefinition](graphdefinition.html): The graph definition publication date [ImplementationGuide](implementationguide.html): The implementation guide publication date [MessageDefinition](messagedefinition.html): The message definition publication date [NamingSystem](namingsystem.html): The naming system publication date [OperationDefinition](operationdefinition.html): The operation definition publication date [SearchParameter](searchparameter.html): The search parameter publication date [StructureDefinition](structuredefinition.html): The structure definition publication date [StructureMap](structuremap.html): The structure map publication date [TerminologyCapabilities](terminologycapabilities.html): The terminology capabilities publication date [ValueSet](valueset.html): The value set publication date
Type: date
Path: CapabilityStatement.date | CodeSystem.date | CompartmentDefinition.date | ConceptMap.date | GraphDefinition.date | ImplementationGuide.date | MessageDefinition.date | NamingSystem.date | OperationDefinition.date | SearchParameter.date | StructureDefinition.date | StructureMap.date | TerminologyCapabilities.date | ValueSet.date
- See Also:
- Constant Field Values
-
DATE
public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
Fluent Client search parameter constant for dateDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): The capability statement publication date [CodeSystem](codesystem.html): The code system publication date [CompartmentDefinition](compartmentdefinition.html): The compartment definition publication date [ConceptMap](conceptmap.html): The concept map publication date [GraphDefinition](graphdefinition.html): The graph definition publication date [ImplementationGuide](implementationguide.html): The implementation guide publication date [MessageDefinition](messagedefinition.html): The message definition publication date [NamingSystem](namingsystem.html): The naming system publication date [OperationDefinition](operationdefinition.html): The operation definition publication date [SearchParameter](searchparameter.html): The search parameter publication date [StructureDefinition](structuredefinition.html): The structure definition publication date [StructureMap](structuremap.html): The structure map publication date [TerminologyCapabilities](terminologycapabilities.html): The terminology capabilities publication date [ValueSet](valueset.html): The value set publication date
Type: date
Path: CapabilityStatement.date | CodeSystem.date | CompartmentDefinition.date | ConceptMap.date | GraphDefinition.date | ImplementationGuide.date | MessageDefinition.date | NamingSystem.date | OperationDefinition.date | SearchParameter.date | StructureDefinition.date | StructureMap.date | TerminologyCapabilities.date | ValueSet.date
-
SP_DESCRIPTION
public static final String SP_DESCRIPTION
Search parameter: descriptionDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): The description of the capability statement [CodeSystem](codesystem.html): The description of the code system [CompartmentDefinition](compartmentdefinition.html): The description of the compartment definition [ConceptMap](conceptmap.html): The description of the concept map [GraphDefinition](graphdefinition.html): The description of the graph definition [ImplementationGuide](implementationguide.html): The description of the implementation guide [MessageDefinition](messagedefinition.html): The description of the message definition [NamingSystem](namingsystem.html): The description of the naming system [OperationDefinition](operationdefinition.html): The description of the operation definition [SearchParameter](searchparameter.html): The description of the search parameter [StructureDefinition](structuredefinition.html): The description of the structure definition [StructureMap](structuremap.html): The description of the structure map [TerminologyCapabilities](terminologycapabilities.html): The description of the terminology capabilities [ValueSet](valueset.html): The description of the value set
Type: string
Path: CapabilityStatement.description | CodeSystem.description | CompartmentDefinition.description | ConceptMap.description | GraphDefinition.description | ImplementationGuide.description | MessageDefinition.description | NamingSystem.description | OperationDefinition.description | SearchParameter.description | StructureDefinition.description | StructureMap.description | TerminologyCapabilities.description | ValueSet.description
- See Also:
- Constant Field Values
-
DESCRIPTION
public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION
Fluent Client search parameter constant for descriptionDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): The description of the capability statement [CodeSystem](codesystem.html): The description of the code system [CompartmentDefinition](compartmentdefinition.html): The description of the compartment definition [ConceptMap](conceptmap.html): The description of the concept map [GraphDefinition](graphdefinition.html): The description of the graph definition [ImplementationGuide](implementationguide.html): The description of the implementation guide [MessageDefinition](messagedefinition.html): The description of the message definition [NamingSystem](namingsystem.html): The description of the naming system [OperationDefinition](operationdefinition.html): The description of the operation definition [SearchParameter](searchparameter.html): The description of the search parameter [StructureDefinition](structuredefinition.html): The description of the structure definition [StructureMap](structuremap.html): The description of the structure map [TerminologyCapabilities](terminologycapabilities.html): The description of the terminology capabilities [ValueSet](valueset.html): The description of the value set
Type: string
Path: CapabilityStatement.description | CodeSystem.description | CompartmentDefinition.description | ConceptMap.description | GraphDefinition.description | ImplementationGuide.description | MessageDefinition.description | NamingSystem.description | OperationDefinition.description | SearchParameter.description | StructureDefinition.description | StructureMap.description | TerminologyCapabilities.description | ValueSet.description
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: Multiple Resources: [CodeSystem](codesystem.html): External identifier for the code system [ConceptMap](conceptmap.html): External identifier for the concept map [MessageDefinition](messagedefinition.html): External identifier for the message definition [StructureDefinition](structuredefinition.html): External identifier for the structure definition [StructureMap](structuremap.html): External identifier for the structure map [ValueSet](valueset.html): External identifier for the value set
Type: token
Path: CodeSystem.identifier | ConceptMap.identifier | MessageDefinition.identifier | StructureDefinition.identifier | StructureMap.identifier | ValueSet.identifier
- See Also:
- Constant Field Values
-
IDENTIFIER
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Multiple Resources: [CodeSystem](codesystem.html): External identifier for the code system [ConceptMap](conceptmap.html): External identifier for the concept map [MessageDefinition](messagedefinition.html): External identifier for the message definition [StructureDefinition](structuredefinition.html): External identifier for the structure definition [StructureMap](structuremap.html): External identifier for the structure map [ValueSet](valueset.html): External identifier for the value set
Type: token
Path: CodeSystem.identifier | ConceptMap.identifier | MessageDefinition.identifier | StructureDefinition.identifier | StructureMap.identifier | ValueSet.identifier
-
SP_JURISDICTION
public static final String SP_JURISDICTION
Search parameter: jurisdictionDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): Intended jurisdiction for the capability statement [CodeSystem](codesystem.html): Intended jurisdiction for the code system [ConceptMap](conceptmap.html): Intended jurisdiction for the concept map [GraphDefinition](graphdefinition.html): Intended jurisdiction for the graph definition [ImplementationGuide](implementationguide.html): Intended jurisdiction for the implementation guide [MessageDefinition](messagedefinition.html): Intended jurisdiction for the message definition [NamingSystem](namingsystem.html): Intended jurisdiction for the naming system [OperationDefinition](operationdefinition.html): Intended jurisdiction for the operation definition [SearchParameter](searchparameter.html): Intended jurisdiction for the search parameter [StructureDefinition](structuredefinition.html): Intended jurisdiction for the structure definition [StructureMap](structuremap.html): Intended jurisdiction for the structure map [TerminologyCapabilities](terminologycapabilities.html): Intended jurisdiction for the terminology capabilities [ValueSet](valueset.html): Intended jurisdiction for the value set
Type: token
Path: CapabilityStatement.jurisdiction | CodeSystem.jurisdiction | ConceptMap.jurisdiction | GraphDefinition.jurisdiction | ImplementationGuide.jurisdiction | MessageDefinition.jurisdiction | NamingSystem.jurisdiction | OperationDefinition.jurisdiction | SearchParameter.jurisdiction | StructureDefinition.jurisdiction | StructureMap.jurisdiction | TerminologyCapabilities.jurisdiction | ValueSet.jurisdiction
- See Also:
- Constant Field Values
-
JURISDICTION
public static final ca.uhn.fhir.rest.gclient.TokenClientParam JURISDICTION
Fluent Client search parameter constant for jurisdictionDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): Intended jurisdiction for the capability statement [CodeSystem](codesystem.html): Intended jurisdiction for the code system [ConceptMap](conceptmap.html): Intended jurisdiction for the concept map [GraphDefinition](graphdefinition.html): Intended jurisdiction for the graph definition [ImplementationGuide](implementationguide.html): Intended jurisdiction for the implementation guide [MessageDefinition](messagedefinition.html): Intended jurisdiction for the message definition [NamingSystem](namingsystem.html): Intended jurisdiction for the naming system [OperationDefinition](operationdefinition.html): Intended jurisdiction for the operation definition [SearchParameter](searchparameter.html): Intended jurisdiction for the search parameter [StructureDefinition](structuredefinition.html): Intended jurisdiction for the structure definition [StructureMap](structuremap.html): Intended jurisdiction for the structure map [TerminologyCapabilities](terminologycapabilities.html): Intended jurisdiction for the terminology capabilities [ValueSet](valueset.html): Intended jurisdiction for the value set
Type: token
Path: CapabilityStatement.jurisdiction | CodeSystem.jurisdiction | ConceptMap.jurisdiction | GraphDefinition.jurisdiction | ImplementationGuide.jurisdiction | MessageDefinition.jurisdiction | NamingSystem.jurisdiction | OperationDefinition.jurisdiction | SearchParameter.jurisdiction | StructureDefinition.jurisdiction | StructureMap.jurisdiction | TerminologyCapabilities.jurisdiction | ValueSet.jurisdiction
-
SP_NAME
public static final String SP_NAME
Search parameter: nameDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): Computationally friendly name of the capability statement [CodeSystem](codesystem.html): Computationally friendly name of the code system [CompartmentDefinition](compartmentdefinition.html): Computationally friendly name of the compartment definition [ConceptMap](conceptmap.html): Computationally friendly name of the concept map [GraphDefinition](graphdefinition.html): Computationally friendly name of the graph definition [ImplementationGuide](implementationguide.html): Computationally friendly name of the implementation guide [MessageDefinition](messagedefinition.html): Computationally friendly name of the message definition [NamingSystem](namingsystem.html): Computationally friendly name of the naming system [OperationDefinition](operationdefinition.html): Computationally friendly name of the operation definition [SearchParameter](searchparameter.html): Computationally friendly name of the search parameter [StructureDefinition](structuredefinition.html): Computationally friendly name of the structure definition [StructureMap](structuremap.html): Computationally friendly name of the structure map [TerminologyCapabilities](terminologycapabilities.html): Computationally friendly name of the terminology capabilities [ValueSet](valueset.html): Computationally friendly name of the value set
Type: string
Path: CapabilityStatement.name | CodeSystem.name | CompartmentDefinition.name | ConceptMap.name | GraphDefinition.name | ImplementationGuide.name | MessageDefinition.name | NamingSystem.name | OperationDefinition.name | SearchParameter.name | StructureDefinition.name | StructureMap.name | TerminologyCapabilities.name | ValueSet.name
- See Also:
- Constant Field Values
-
NAME
public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME
Fluent Client search parameter constant for nameDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): Computationally friendly name of the capability statement [CodeSystem](codesystem.html): Computationally friendly name of the code system [CompartmentDefinition](compartmentdefinition.html): Computationally friendly name of the compartment definition [ConceptMap](conceptmap.html): Computationally friendly name of the concept map [GraphDefinition](graphdefinition.html): Computationally friendly name of the graph definition [ImplementationGuide](implementationguide.html): Computationally friendly name of the implementation guide [MessageDefinition](messagedefinition.html): Computationally friendly name of the message definition [NamingSystem](namingsystem.html): Computationally friendly name of the naming system [OperationDefinition](operationdefinition.html): Computationally friendly name of the operation definition [SearchParameter](searchparameter.html): Computationally friendly name of the search parameter [StructureDefinition](structuredefinition.html): Computationally friendly name of the structure definition [StructureMap](structuremap.html): Computationally friendly name of the structure map [TerminologyCapabilities](terminologycapabilities.html): Computationally friendly name of the terminology capabilities [ValueSet](valueset.html): Computationally friendly name of the value set
Type: string
Path: CapabilityStatement.name | CodeSystem.name | CompartmentDefinition.name | ConceptMap.name | GraphDefinition.name | ImplementationGuide.name | MessageDefinition.name | NamingSystem.name | OperationDefinition.name | SearchParameter.name | StructureDefinition.name | StructureMap.name | TerminologyCapabilities.name | ValueSet.name
-
SP_PUBLISHER
public static final String SP_PUBLISHER
Search parameter: publisherDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): Name of the publisher of the capability statement [CodeSystem](codesystem.html): Name of the publisher of the code system [CompartmentDefinition](compartmentdefinition.html): Name of the publisher of the compartment definition [ConceptMap](conceptmap.html): Name of the publisher of the concept map [GraphDefinition](graphdefinition.html): Name of the publisher of the graph definition [ImplementationGuide](implementationguide.html): Name of the publisher of the implementation guide [MessageDefinition](messagedefinition.html): Name of the publisher of the message definition [NamingSystem](namingsystem.html): Name of the publisher of the naming system [OperationDefinition](operationdefinition.html): Name of the publisher of the operation definition [SearchParameter](searchparameter.html): Name of the publisher of the search parameter [StructureDefinition](structuredefinition.html): Name of the publisher of the structure definition [StructureMap](structuremap.html): Name of the publisher of the structure map [TerminologyCapabilities](terminologycapabilities.html): Name of the publisher of the terminology capabilities [ValueSet](valueset.html): Name of the publisher of the value set
Type: string
Path: CapabilityStatement.publisher | CodeSystem.publisher | CompartmentDefinition.publisher | ConceptMap.publisher | GraphDefinition.publisher | ImplementationGuide.publisher | MessageDefinition.publisher | NamingSystem.publisher | OperationDefinition.publisher | SearchParameter.publisher | StructureDefinition.publisher | StructureMap.publisher | TerminologyCapabilities.publisher | ValueSet.publisher
- See Also:
- Constant Field Values
-
PUBLISHER
public static final ca.uhn.fhir.rest.gclient.StringClientParam PUBLISHER
Fluent Client search parameter constant for publisherDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): Name of the publisher of the capability statement [CodeSystem](codesystem.html): Name of the publisher of the code system [CompartmentDefinition](compartmentdefinition.html): Name of the publisher of the compartment definition [ConceptMap](conceptmap.html): Name of the publisher of the concept map [GraphDefinition](graphdefinition.html): Name of the publisher of the graph definition [ImplementationGuide](implementationguide.html): Name of the publisher of the implementation guide [MessageDefinition](messagedefinition.html): Name of the publisher of the message definition [NamingSystem](namingsystem.html): Name of the publisher of the naming system [OperationDefinition](operationdefinition.html): Name of the publisher of the operation definition [SearchParameter](searchparameter.html): Name of the publisher of the search parameter [StructureDefinition](structuredefinition.html): Name of the publisher of the structure definition [StructureMap](structuremap.html): Name of the publisher of the structure map [TerminologyCapabilities](terminologycapabilities.html): Name of the publisher of the terminology capabilities [ValueSet](valueset.html): Name of the publisher of the value set
Type: string
Path: CapabilityStatement.publisher | CodeSystem.publisher | CompartmentDefinition.publisher | ConceptMap.publisher | GraphDefinition.publisher | ImplementationGuide.publisher | MessageDefinition.publisher | NamingSystem.publisher | OperationDefinition.publisher | SearchParameter.publisher | StructureDefinition.publisher | StructureMap.publisher | TerminologyCapabilities.publisher | ValueSet.publisher
-
SP_STATUS
public static final String SP_STATUS
Search parameter: statusDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): The current status of the capability statement [CodeSystem](codesystem.html): The current status of the code system [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition [ConceptMap](conceptmap.html): The current status of the concept map [GraphDefinition](graphdefinition.html): The current status of the graph definition [ImplementationGuide](implementationguide.html): The current status of the implementation guide [MessageDefinition](messagedefinition.html): The current status of the message definition [NamingSystem](namingsystem.html): The current status of the naming system [OperationDefinition](operationdefinition.html): The current status of the operation definition [SearchParameter](searchparameter.html): The current status of the search parameter [StructureDefinition](structuredefinition.html): The current status of the structure definition [StructureMap](structuremap.html): The current status of the structure map [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities [ValueSet](valueset.html): The current status of the value set
Type: token
Path: CapabilityStatement.status | CodeSystem.status | CompartmentDefinition.status | ConceptMap.status | GraphDefinition.status | ImplementationGuide.status | MessageDefinition.status | NamingSystem.status | OperationDefinition.status | SearchParameter.status | StructureDefinition.status | StructureMap.status | TerminologyCapabilities.status | ValueSet.status
- See Also:
- Constant Field Values
-
STATUS
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
Fluent Client search parameter constant for statusDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): The current status of the capability statement [CodeSystem](codesystem.html): The current status of the code system [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition [ConceptMap](conceptmap.html): The current status of the concept map [GraphDefinition](graphdefinition.html): The current status of the graph definition [ImplementationGuide](implementationguide.html): The current status of the implementation guide [MessageDefinition](messagedefinition.html): The current status of the message definition [NamingSystem](namingsystem.html): The current status of the naming system [OperationDefinition](operationdefinition.html): The current status of the operation definition [SearchParameter](searchparameter.html): The current status of the search parameter [StructureDefinition](structuredefinition.html): The current status of the structure definition [StructureMap](structuremap.html): The current status of the structure map [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities [ValueSet](valueset.html): The current status of the value set
Type: token
Path: CapabilityStatement.status | CodeSystem.status | CompartmentDefinition.status | ConceptMap.status | GraphDefinition.status | ImplementationGuide.status | MessageDefinition.status | NamingSystem.status | OperationDefinition.status | SearchParameter.status | StructureDefinition.status | StructureMap.status | TerminologyCapabilities.status | ValueSet.status
-
SP_TITLE
public static final String SP_TITLE
Search parameter: titleDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): The human-friendly name of the capability statement [CodeSystem](codesystem.html): The human-friendly name of the code system [ConceptMap](conceptmap.html): The human-friendly name of the concept map [ImplementationGuide](implementationguide.html): The human-friendly name of the implementation guide [MessageDefinition](messagedefinition.html): The human-friendly name of the message definition [OperationDefinition](operationdefinition.html): The human-friendly name of the operation definition [StructureDefinition](structuredefinition.html): The human-friendly name of the structure definition [StructureMap](structuremap.html): The human-friendly name of the structure map [TerminologyCapabilities](terminologycapabilities.html): The human-friendly name of the terminology capabilities [ValueSet](valueset.html): The human-friendly name of the value set
Type: string
Path: CapabilityStatement.title | CodeSystem.title | ConceptMap.title | ImplementationGuide.title | MessageDefinition.title | OperationDefinition.title | StructureDefinition.title | StructureMap.title | TerminologyCapabilities.title | ValueSet.title
- See Also:
- Constant Field Values
-
TITLE
public static final ca.uhn.fhir.rest.gclient.StringClientParam TITLE
Fluent Client search parameter constant for titleDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): The human-friendly name of the capability statement [CodeSystem](codesystem.html): The human-friendly name of the code system [ConceptMap](conceptmap.html): The human-friendly name of the concept map [ImplementationGuide](implementationguide.html): The human-friendly name of the implementation guide [MessageDefinition](messagedefinition.html): The human-friendly name of the message definition [OperationDefinition](operationdefinition.html): The human-friendly name of the operation definition [StructureDefinition](structuredefinition.html): The human-friendly name of the structure definition [StructureMap](structuremap.html): The human-friendly name of the structure map [TerminologyCapabilities](terminologycapabilities.html): The human-friendly name of the terminology capabilities [ValueSet](valueset.html): The human-friendly name of the value set
Type: string
Path: CapabilityStatement.title | CodeSystem.title | ConceptMap.title | ImplementationGuide.title | MessageDefinition.title | OperationDefinition.title | StructureDefinition.title | StructureMap.title | TerminologyCapabilities.title | ValueSet.title
-
SP_URL
public static final String SP_URL
Search parameter: urlDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): The uri that identifies the capability statement [CodeSystem](codesystem.html): The uri that identifies the code system [CompartmentDefinition](compartmentdefinition.html): The uri that identifies the compartment definition [ConceptMap](conceptmap.html): The uri that identifies the concept map [GraphDefinition](graphdefinition.html): The uri that identifies the graph definition [ImplementationGuide](implementationguide.html): The uri that identifies the implementation guide [MessageDefinition](messagedefinition.html): The uri that identifies the message definition [OperationDefinition](operationdefinition.html): The uri that identifies the operation definition [SearchParameter](searchparameter.html): The uri that identifies the search parameter [StructureDefinition](structuredefinition.html): The uri that identifies the structure definition [StructureMap](structuremap.html): The uri that identifies the structure map [TerminologyCapabilities](terminologycapabilities.html): The uri that identifies the terminology capabilities [ValueSet](valueset.html): The uri that identifies the value set
Type: uri
Path: CapabilityStatement.url | CodeSystem.url | CompartmentDefinition.url | ConceptMap.url | GraphDefinition.url | ImplementationGuide.url | MessageDefinition.url | OperationDefinition.url | SearchParameter.url | StructureDefinition.url | StructureMap.url | TerminologyCapabilities.url | ValueSet.url
- See Also:
- Constant Field Values
-
URL
public static final ca.uhn.fhir.rest.gclient.UriClientParam URL
Fluent Client search parameter constant for urlDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): The uri that identifies the capability statement [CodeSystem](codesystem.html): The uri that identifies the code system [CompartmentDefinition](compartmentdefinition.html): The uri that identifies the compartment definition [ConceptMap](conceptmap.html): The uri that identifies the concept map [GraphDefinition](graphdefinition.html): The uri that identifies the graph definition [ImplementationGuide](implementationguide.html): The uri that identifies the implementation guide [MessageDefinition](messagedefinition.html): The uri that identifies the message definition [OperationDefinition](operationdefinition.html): The uri that identifies the operation definition [SearchParameter](searchparameter.html): The uri that identifies the search parameter [StructureDefinition](structuredefinition.html): The uri that identifies the structure definition [StructureMap](structuremap.html): The uri that identifies the structure map [TerminologyCapabilities](terminologycapabilities.html): The uri that identifies the terminology capabilities [ValueSet](valueset.html): The uri that identifies the value set
Type: uri
Path: CapabilityStatement.url | CodeSystem.url | CompartmentDefinition.url | ConceptMap.url | GraphDefinition.url | ImplementationGuide.url | MessageDefinition.url | OperationDefinition.url | SearchParameter.url | StructureDefinition.url | StructureMap.url | TerminologyCapabilities.url | ValueSet.url
-
SP_VERSION
public static final String SP_VERSION
Search parameter: versionDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): The business version of the capability statement [CodeSystem](codesystem.html): The business version of the code system [CompartmentDefinition](compartmentdefinition.html): The business version of the compartment definition [ConceptMap](conceptmap.html): The business version of the concept map [GraphDefinition](graphdefinition.html): The business version of the graph definition [ImplementationGuide](implementationguide.html): The business version of the implementation guide [MessageDefinition](messagedefinition.html): The business version of the message definition [OperationDefinition](operationdefinition.html): The business version of the operation definition [SearchParameter](searchparameter.html): The business version of the search parameter [StructureDefinition](structuredefinition.html): The business version of the structure definition [StructureMap](structuremap.html): The business version of the structure map [TerminologyCapabilities](terminologycapabilities.html): The business version of the terminology capabilities [ValueSet](valueset.html): The business version of the value set
Type: token
Path: CapabilityStatement.version | CodeSystem.version | CompartmentDefinition.version | ConceptMap.version | GraphDefinition.version | ImplementationGuide.version | MessageDefinition.version | OperationDefinition.version | SearchParameter.version | StructureDefinition.version | StructureMap.version | TerminologyCapabilities.version | ValueSet.version
- See Also:
- Constant Field Values
-
VERSION
public static final ca.uhn.fhir.rest.gclient.TokenClientParam VERSION
Fluent Client search parameter constant for versionDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): The business version of the capability statement [CodeSystem](codesystem.html): The business version of the code system [CompartmentDefinition](compartmentdefinition.html): The business version of the compartment definition [ConceptMap](conceptmap.html): The business version of the concept map [GraphDefinition](graphdefinition.html): The business version of the graph definition [ImplementationGuide](implementationguide.html): The business version of the implementation guide [MessageDefinition](messagedefinition.html): The business version of the message definition [OperationDefinition](operationdefinition.html): The business version of the operation definition [SearchParameter](searchparameter.html): The business version of the search parameter [StructureDefinition](structuredefinition.html): The business version of the structure definition [StructureMap](structuremap.html): The business version of the structure map [TerminologyCapabilities](terminologycapabilities.html): The business version of the terminology capabilities [ValueSet](valueset.html): The business version of the value set
Type: token
Path: CapabilityStatement.version | CodeSystem.version | CompartmentDefinition.version | ConceptMap.version | GraphDefinition.version | ImplementationGuide.version | MessageDefinition.version | OperationDefinition.version | SearchParameter.version | StructureDefinition.version | StructureMap.version | TerminologyCapabilities.version | ValueSet.version
-
-
Constructor Detail
-
MessageDefinition
public MessageDefinition()
Constructor
-
MessageDefinition
public MessageDefinition(Enumerations.PublicationStatus status, Date date, DataType event)
Constructor
-
-
Method Detail
-
getUrlElement
public UriType getUrlElement()
- Specified by:
getUrlElementin classCanonicalResource- Returns:
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
public boolean hasUrlElement()
- Specified by:
hasUrlElementin classCanonicalResource
-
hasUrl
public boolean hasUrl()
- Specified by:
hasUrlin classCanonicalResource
-
setUrlElement
public MessageDefinition setUrlElement(UriType value)
- Specified by:
setUrlElementin classCanonicalResource- Parameters:
value-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
public String getUrl()
- Specified by:
getUrlin classCanonicalResource- Returns:
- The business identifier that is used to reference the MessageDefinition and *is* expected to be consistent from server to server.
-
setUrl
public MessageDefinition setUrl(String value)
- Specified by:
setUrlin classCanonicalResource- Parameters:
value- The business identifier that is used to reference the MessageDefinition and *is* expected to be consistent from server to server.
-
getIdentifier
public List<Identifier> getIdentifier()
- Specified by:
getIdentifierin classCanonicalResource- 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
public MessageDefinition setIdentifier(List<Identifier> theIdentifier)
- Specified by:
setIdentifierin classCanonicalResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIdentifier
public boolean hasIdentifier()
- Specified by:
hasIdentifierin classCanonicalResource
-
addIdentifier
public Identifier addIdentifier()
- Specified by:
addIdentifierin classCanonicalResource
-
addIdentifier
public MessageDefinition addIdentifier(Identifier t)
- Specified by:
addIdentifierin classCanonicalResource
-
getIdentifierFirstRep
public Identifier getIdentifierFirstRep()
- Specified by:
getIdentifierFirstRepin classCanonicalResource- Returns:
- The first repetition of repeating field
identifier, creating it if it does not already exist {3}
-
getVersionElement
public StringType getVersionElement()
- Specified by:
getVersionElementin classCanonicalResource- Returns:
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()
- Specified by:
hasVersionElementin classCanonicalResource
-
hasVersion
public boolean hasVersion()
- Specified by:
hasVersionin classCanonicalResource
-
setVersionElement
public MessageDefinition setVersionElement(StringType value)
- Specified by:
setVersionElementin classCanonicalResource- Parameters:
value-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()
- Specified by:
getVersionin classCanonicalResource- 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)
- Specified by:
setVersionin classCanonicalResource- 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()
- Specified by:
getNameElementin classCanonicalResource- Returns:
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()
- Specified by:
hasNameElementin classCanonicalResource
-
hasName
public boolean hasName()
- Specified by:
hasNamein classCanonicalResource
-
setNameElement
public MessageDefinition setNameElement(StringType value)
- Specified by:
setNameElementin classCanonicalResource- Parameters:
value-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()
- Specified by:
getNamein classCanonicalResource- 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)
- Specified by:
setNamein classCanonicalResource- 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()
- Specified by:
getTitleElementin classCanonicalResource- Returns:
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()
- Specified by:
hasTitleElementin classCanonicalResource
-
hasTitle
public boolean hasTitle()
- Specified by:
hasTitlein classCanonicalResource
-
setTitleElement
public MessageDefinition setTitleElement(StringType value)
- Specified by:
setTitleElementin classCanonicalResource- Parameters:
value-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()
- Specified by:
getTitlein classCanonicalResource- Returns:
- A short, descriptive, user-friendly title for the message definition.
-
setTitle
public MessageDefinition setTitle(String value)
- Specified by:
setTitlein classCanonicalResource- Parameters:
value- A short, descriptive, user-friendly title for the message definition.
-
getReplaces
public List<CanonicalType> getReplaces()
- Returns:
replaces(A MessageDefinition that is superseded by this definition.)
-
setReplaces
public MessageDefinition setReplaces(List<CanonicalType> theReplaces)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasReplaces
public boolean hasReplaces()
-
addReplacesElement
public CanonicalType addReplacesElement()
- Returns:
replaces(A MessageDefinition that is superseded by this definition.)
-
addReplaces
public MessageDefinition addReplaces(String value)
- Parameters:
value-replaces(A MessageDefinition that is superseded by this definition.)
-
hasReplaces
public boolean hasReplaces(String value)
- Parameters:
value-replaces(A MessageDefinition that is superseded by this definition.)
-
getStatusElement
public Enumeration<Enumerations.PublicationStatus> getStatusElement()
- Specified by:
getStatusElementin classCanonicalResource- Returns:
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()
- Specified by:
hasStatusElementin classCanonicalResource
-
hasStatus
public boolean hasStatus()
- Specified by:
hasStatusin classCanonicalResource
-
setStatusElement
public MessageDefinition setStatusElement(Enumeration<Enumerations.PublicationStatus> value)
- Specified by:
setStatusElementin classCanonicalResource- Parameters:
value-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()
- Specified by:
getStatusin classCanonicalResource- Returns:
- The status of this message definition. Enables tracking the life-cycle of the content.
-
setStatus
public MessageDefinition setStatus(Enumerations.PublicationStatus value)
- Specified by:
setStatusin classCanonicalResource- Parameters:
value- The status of this message definition. Enables tracking the life-cycle of the content.
-
getExperimentalElement
public BooleanType getExperimentalElement()
- Specified by:
getExperimentalElementin classCanonicalResource- Returns:
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()
- Specified by:
hasExperimentalElementin classCanonicalResource
-
hasExperimental
public boolean hasExperimental()
- Specified by:
hasExperimentalin classCanonicalResource
-
setExperimentalElement
public MessageDefinition setExperimentalElement(BooleanType value)
- Specified by:
setExperimentalElementin classCanonicalResource- Parameters:
value-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()
- Specified by:
getExperimentalin classCanonicalResource- 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)
- Specified by:
setExperimentalin classCanonicalResource- 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()
- Specified by:
getDateElementin classCanonicalResource- Returns:
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
public boolean hasDateElement()
- Specified by:
hasDateElementin classCanonicalResource
-
hasDate
public boolean hasDate()
- Specified by:
hasDatein classCanonicalResource
-
setDateElement
public MessageDefinition setDateElement(DateTimeType value)
- Specified by:
setDateElementin classCanonicalResource- Parameters:
value-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
public Date getDate()
- Specified by:
getDatein classCanonicalResource- 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
public MessageDefinition setDate(Date value)
- Specified by:
setDatein classCanonicalResource- 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
public StringType getPublisherElement()
- Specified by:
getPublisherElementin classCanonicalResource- Returns:
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
public boolean hasPublisherElement()
- Specified by:
hasPublisherElementin classCanonicalResource
-
hasPublisher
public boolean hasPublisher()
- Specified by:
hasPublisherin classCanonicalResource
-
setPublisherElement
public MessageDefinition setPublisherElement(StringType value)
- Specified by:
setPublisherElementin classCanonicalResource- Parameters:
value-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
public String getPublisher()
- Specified by:
getPublisherin classCanonicalResource- Returns:
- The name of the organization or individual that published the message definition.
-
setPublisher
public MessageDefinition setPublisher(String value)
- Specified by:
setPublisherin classCanonicalResource- Parameters:
value- The name of the organization or individual that published the message definition.
-
getContact
public List<ContactDetail> getContact()
- Specified by:
getContactin classCanonicalResource- Returns:
contact(Contact details to assist a user in finding and communicating with the publisher.)
-
setContact
public MessageDefinition setContact(List<ContactDetail> theContact)
- Specified by:
setContactin classCanonicalResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasContact
public boolean hasContact()
- Specified by:
hasContactin classCanonicalResource
-
addContact
public ContactDetail addContact()
- Specified by:
addContactin classCanonicalResource
-
addContact
public MessageDefinition addContact(ContactDetail t)
- Specified by:
addContactin classCanonicalResource
-
getContactFirstRep
public ContactDetail getContactFirstRep()
- Specified by:
getContactFirstRepin classCanonicalResource- Returns:
- The first repetition of repeating field
contact, creating it if it does not already exist {3}
-
getDescriptionElement
public MarkdownType getDescriptionElement()
- Specified by:
getDescriptionElementin classCanonicalResource- Returns:
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()
- Specified by:
hasDescriptionElementin classCanonicalResource
-
hasDescription
public boolean hasDescription()
- Specified by:
hasDescriptionin classCanonicalResource
-
setDescriptionElement
public MessageDefinition setDescriptionElement(MarkdownType value)
- Specified by:
setDescriptionElementin classCanonicalResource- Parameters:
value-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()
- Specified by:
getDescriptionin classCanonicalResource- Returns:
- A free text natural language description of the message definition from a consumer's perspective.
-
setDescription
public MessageDefinition setDescription(String value)
- Specified by:
setDescriptionin classCanonicalResource- Parameters:
value- A free text natural language description of the message definition from a consumer's perspective.
-
getUseContext
public List<UsageContext> getUseContext()
- Specified by:
getUseContextin classCanonicalResource- Returns:
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
public MessageDefinition setUseContext(List<UsageContext> theUseContext)
- Specified by:
setUseContextin classCanonicalResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasUseContext
public boolean hasUseContext()
- Specified by:
hasUseContextin classCanonicalResource
-
addUseContext
public UsageContext addUseContext()
- Specified by:
addUseContextin classCanonicalResource
-
addUseContext
public MessageDefinition addUseContext(UsageContext t)
- Specified by:
addUseContextin classCanonicalResource
-
getUseContextFirstRep
public UsageContext getUseContextFirstRep()
- Specified by:
getUseContextFirstRepin classCanonicalResource- Returns:
- The first repetition of repeating field
useContext, creating it if it does not already exist {3}
-
getJurisdiction
public List<CodeableConcept> getJurisdiction()
- Specified by:
getJurisdictionin classCanonicalResource- Returns:
jurisdiction(A legal or geographic region in which the message definition is intended to be used.)
-
setJurisdiction
public MessageDefinition setJurisdiction(List<CodeableConcept> theJurisdiction)
- Specified by:
setJurisdictionin classCanonicalResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasJurisdiction
public boolean hasJurisdiction()
- Specified by:
hasJurisdictionin classCanonicalResource
-
addJurisdiction
public CodeableConcept addJurisdiction()
- Specified by:
addJurisdictionin classCanonicalResource
-
addJurisdiction
public MessageDefinition addJurisdiction(CodeableConcept t)
- Specified by:
addJurisdictionin classCanonicalResource
-
getJurisdictionFirstRep
public CodeableConcept getJurisdictionFirstRep()
- Specified by:
getJurisdictionFirstRepin classCanonicalResource- Returns:
- The first repetition of repeating field
jurisdiction, creating it if it does not already exist {3}
-
getPurposeElement
public MarkdownType getPurposeElement()
- Specified by:
getPurposeElementin classCanonicalResource- 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
public boolean hasPurposeElement()
- Specified by:
hasPurposeElementin classCanonicalResource
-
hasPurpose
public boolean hasPurpose()
- Specified by:
hasPurposein classCanonicalResource
-
setPurposeElement
public MessageDefinition setPurposeElement(MarkdownType value)
- Specified by:
setPurposeElementin classCanonicalResource- 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
public String getPurpose()
- Specified by:
getPurposein classCanonicalResource- Returns:
- Explanation of why this message definition is needed and why it has been designed as it has.
-
setPurpose
public MessageDefinition setPurpose(String value)
- Specified by:
setPurposein classCanonicalResource- Parameters:
value- Explanation of why this message definition is needed and why it has been designed as it has.
-
getCopyrightElement
public MarkdownType getCopyrightElement()
- Specified by:
getCopyrightElementin classCanonicalResource- 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()
- Specified by:
hasCopyrightElementin classCanonicalResource
-
hasCopyright
public boolean hasCopyright()
- Specified by:
hasCopyrightin classCanonicalResource
-
setCopyrightElement
public MessageDefinition setCopyrightElement(MarkdownType value)
- Specified by:
setCopyrightElementin classCanonicalResource- 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()
- Specified by:
getCopyrightin classCanonicalResource- 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)
- Specified by:
setCopyrightin classCanonicalResource- 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
public CanonicalType 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
public boolean hasBaseElement()
-
hasBase
public boolean hasBase()
-
setBaseElement
public MessageDefinition setBaseElement(CanonicalType value)
- 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
public String getBase()
- Returns:
- The MessageDefinition that is the basis for the contents of this resource.
-
setBase
public MessageDefinition setBase(String value)
- Parameters:
value- The MessageDefinition that is the basis for the contents of this resource.
-
getParent
public List<CanonicalType> getParent()
- Returns:
parent(Identifies a protocol or workflow that this MessageDefinition represents a step in.)
-
setParent
public MessageDefinition setParent(List<CanonicalType> theParent)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasParent
public boolean hasParent()
-
addParentElement
public CanonicalType addParentElement()
- Returns:
parent(Identifies a protocol or workflow that this MessageDefinition represents a step in.)
-
addParent
public MessageDefinition addParent(String value)
- Parameters:
value-parent(Identifies a protocol or workflow that this MessageDefinition represents a step in.)
-
hasParent
public boolean hasParent(String value)
- Parameters:
value-parent(Identifies a protocol or workflow that this MessageDefinition represents a step in.)
-
getEventCoding
public Coding getEventCoding() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
event(Event code or link to the EventDefinition.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasEventCoding
public boolean hasEventCoding()
-
getEventUriType
public UriType getEventUriType() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
event(Event code or link to the EventDefinition.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasEventUriType
public boolean hasEventUriType()
-
hasEvent
public boolean hasEvent()
-
setEvent
public MessageDefinition setEvent(DataType value)
- Parameters:
value-event(Event code or link to the EventDefinition.)
-
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
thisfor 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 {3}
-
getResponseRequiredElement
public Enumeration<MessageDefinition.MessageheaderResponseRequest> 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
public boolean hasResponseRequiredElement()
-
hasResponseRequired
public boolean 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
public MessageDefinition.MessageheaderResponseRequest getResponseRequired()
- Returns:
- Declare at a message definition level whether a response is required or only upon error or success, or never.
-
setResponseRequired
public MessageDefinition setResponseRequired(MessageDefinition.MessageheaderResponseRequest value)
- Parameters:
value- Declare at a message definition level whether a response is required or only upon error or success, or never.
-
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
thisfor 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 {3}
-
getGraph
public List<CanonicalType> getGraph()
- Returns:
graph(Canonical reference to a GraphDefinition. If a URL is provided, it is the canonical reference to a [GraphDefinition](graphdefinition.html) 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
public MessageDefinition setGraph(List<CanonicalType> theGraph)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasGraph
public boolean hasGraph()
-
addGraphElement
public CanonicalType addGraphElement()
- Returns:
graph(Canonical reference to a GraphDefinition. If a URL is provided, it is the canonical reference to a [GraphDefinition](graphdefinition.html) 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
public MessageDefinition addGraph(String value)
- Parameters:
value-graph(Canonical reference to a GraphDefinition. If a URL is provided, it is the canonical reference to a [GraphDefinition](graphdefinition.html) 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
public boolean hasGraph(String value)
- Parameters:
value-graph(Canonical reference to a GraphDefinition. If a URL is provided, it is the canonical reference to a [GraphDefinition](graphdefinition.html) 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
protected void listChildren(List<Property> children)
- Overrides:
listChildrenin classCanonicalResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedPropertyin classCanonicalResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classCanonicalResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classCanonicalResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classCanonicalResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makePropertyin classCanonicalResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForPropertyin classCanonicalResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classCanonicalResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classCanonicalResource
-
copy
public MessageDefinition copy()
- Specified by:
copyin classCanonicalResource
-
copyValues
public void copyValues(MessageDefinition dst)
-
typedCopy
protected MessageDefinition typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeepin classCanonicalResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallowin classCanonicalResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classCanonicalResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-