
Class CompartmentDefinition
- All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement
,Serializable
,org.hl7.fhir.instance.model.api.IAnyResource
,org.hl7.fhir.instance.model.api.IBase
,org.hl7.fhir.instance.model.api.IBaseHasExtensions
,org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions
,org.hl7.fhir.instance.model.api.IBaseResource
,org.hl7.fhir.instance.model.api.IDomainResource
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Enumeration<Enumerations.CompartmentType>
Which compartment this definition describes.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for codeprotected List<ContactDetail>
Contact details to assist a user in finding and communicating with the publisher.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for contextstatic final ca.uhn.fhir.rest.gclient.QuantityClientParam
Fluent Client search parameter constant for context-quantitystatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for context-typestatic final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,
ca.uhn.fhir.rest.gclient.QuantityClientParam> Fluent Client search parameter constant for context-type-quantitystatic final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,
ca.uhn.fhir.rest.gclient.TokenClientParam> Fluent Client search parameter constant for context-type-valueprotected DateTimeType
The date (and optionally time) when the compartment definition was published.static final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for dateprotected MarkdownType
A free text natural language description of the compartment definition from a consumer's perspective.static final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for descriptionprotected BooleanType
A Boolean value to indicate that this compartment definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.protected StringType
A natural language name identifying the compartment definition.static final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for nameprotected StringType
The name of the organization or individual that published the compartment definition.static final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for publisherprotected MarkdownType
Explanation of why this compartment definition is needed and why it has been designed as it has.Information about how a resource is related to the compartment.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for resourceprotected BooleanType
Whether the search syntax is supported,.static final String
Search parameter: codestatic final String
Search parameter: contextstatic final String
Search parameter: context-quantitystatic final String
Search parameter: context-typestatic final String
Search parameter: context-type-quantitystatic final String
Search parameter: context-type-valuestatic final String
Search parameter: datestatic final String
Search parameter: descriptionstatic final String
Search parameter: namestatic final String
Search parameter: publisherstatic final String
Search parameter: resourcestatic final String
Search parameter: statusstatic final String
Search parameter: urlstatic final String
Search parameter: versionprotected Enumeration<Enumerations.PublicationStatus>
The status of this compartment definition.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for statusprotected UriType
An absolute URI that is used to identify this compartment definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier.static final ca.uhn.fhir.rest.gclient.UriClientParam
Fluent Client search parameter constant for urlprotected List<UsageContext>
The content was developed with a focus and intent of supporting the contexts that are listed.protected StringType
The identifier that is used to identify this version of the compartment definition when it is referenced in a specification, model, design or instance.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for versionFields inherited from class org.hl7.fhir.r5.model.DomainResource
contained, extension, modifierExtension, SP_TEXT, text, TEXT
Fields inherited from class org.hl7.fhir.r5.model.Resource
id, implicitRules, language, meta
Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, SP_RES_ID
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
ConstructorsConstructorDescriptionConstructorCompartmentDefinition
(String url, String name, Enumerations.PublicationStatus status, Enumerations.CompartmentType code, boolean search) Constructor -
Method Summary
Modifier and TypeMethodDescriptioncopy()
void
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getCode()
int
not supported on this implementationgetDate()
boolean
int
not supported on this implementationint
not supported on this implementationgetName()
getNamedProperty
(int _hash, String _name, boolean _checkValid) Base[]
getProperty
(int hash, String name, boolean checkValid) boolean
getTitle()
int
not supported on this implementationString[]
getTypesForProperty
(int hash, String name) getUrl()
boolean
hasCode()
boolean
boolean
boolean
boolean
boolean
hasDate()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasName()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasTitle()
boolean
boolean
hasUrl()
boolean
boolean
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) setContact
(List<ContactDetail> theContact) setCopyright
(String value) setCopyrightElement
(MarkdownType value) setDateElement
(DateTimeType value) setDescription
(String value) setExperimental
(boolean value) setIdentifier
(List<Identifier> theIdentifier) setJurisdiction
(List<CodeableConcept> theJurisdiction) setNameElement
(StringType value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setPublisher
(String value) setPublisherElement
(StringType value) setPurpose
(String value) setPurposeElement
(MarkdownType value) setSearch
(boolean value) setSearchElement
(BooleanType value) setTitleElement
(StringType value) setUrlElement
(UriType value) setUseContext
(List<UsageContext> theUseContext) setVersion
(String value) setVersionElement
(StringType value) boolean
protected CompartmentDefinition
Methods inherited from class org.hl7.fhir.r5.model.CanonicalResource
copyValues, getContactMax, getDateMax, getDescriptionMax, getExperimentalMax, getNameMax, getPublisherMax, getPurposeMax, getStatusMax, getUrlMax, getUseContextMax, getVersionedUrl, getVersionMax, getVUrl, present, supportsExperimental, toString
Methods inherited from class org.hl7.fhir.r5.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.r5.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.r5.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
Methods inherited from class org.hl7.fhir.r5.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
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, setId
-
Field Details
-
url
An absolute URI that is used to identify this compartment definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this compartment definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the compartment definition is stored on different servers. -
version
The identifier that is used to identify this version of the compartment definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the compartment 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
A natural language name identifying the compartment definition. This name should be usable as an identifier for the module by machine processing applications such as code generation. -
status
The status of this compartment definition. Enables tracking the life-cycle of the content. -
experimental
A Boolean value to indicate that this compartment definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. -
date
The date (and optionally time) when the compartment 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 compartment definition changes. -
publisher
The name of the organization or individual that published the compartment definition. -
contact
Contact details to assist a user in finding and communicating with the publisher. -
description
A free text natural language description of the compartment definition from a consumer's perspective. -
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 compartment definition instances. -
purpose
Explanation of why this compartment definition is needed and why it has been designed as it has. -
code
Which compartment this definition describes. -
search
Whether the search syntax is supported,. -
resource
Information about how a resource is related to the compartment. -
SP_CODE
Search parameter: codeDescription: Patient | Encounter | RelatedPerson | Practitioner | Device
Type: token
Path: CompartmentDefinition.code
- See Also:
-
CODE
Fluent Client search parameter constant for codeDescription: Patient | Encounter | RelatedPerson | Practitioner | Device
Type: token
Path: CompartmentDefinition.code
-
SP_RESOURCE
Search parameter: resourceDescription: Name of resource type
Type: token
Path: CompartmentDefinition.resource.code
- See Also:
-
RESOURCE
Fluent Client search parameter constant for resourceDescription: Name of resource type
Type: token
Path: CompartmentDefinition.resource.code
-
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:
-
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
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:
-
CONTEXT_TYPE_QUANTITY
public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.QuantityClientParam> CONTEXT_TYPE_QUANTITYFluent Client search parameter constant for context-type-quantityDescription: 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
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:
-
CONTEXT_TYPE_VALUE
public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam> CONTEXT_TYPE_VALUEFluent Client search parameter constant for context-type-valueDescription: 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
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:
-
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
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:
-
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
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:
-
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
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:
-
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_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:
-
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
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:
-
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
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:
-
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_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 [NamingSystem](namingsystem.html): The uri that identifies the naming system [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 | NamingSystem.url | OperationDefinition.url | SearchParameter.url | StructureDefinition.url | StructureMap.url | TerminologyCapabilities.url | ValueSet.url
- See Also:
-
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 [NamingSystem](namingsystem.html): The uri that identifies the naming system [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 | NamingSystem.url | OperationDefinition.url | SearchParameter.url | StructureDefinition.url | StructureMap.url | TerminologyCapabilities.url | ValueSet.url
-
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 [NamingSystem](namingsystem.html): The business version of the naming system [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 | NamingSystem.version | OperationDefinition.version | SearchParameter.version | StructureDefinition.version | StructureMap.version | TerminologyCapabilities.version | ValueSet.version
- See Also:
-
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 [NamingSystem](namingsystem.html): The business version of the naming system [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 | NamingSystem.version | OperationDefinition.version | SearchParameter.version | StructureDefinition.version | StructureMap.version | TerminologyCapabilities.version | ValueSet.version
-
-
Constructor Details
-
CompartmentDefinition
public CompartmentDefinition()Constructor -
CompartmentDefinition
public CompartmentDefinition(String url, String name, Enumerations.PublicationStatus status, Enumerations.CompartmentType code, boolean search) Constructor
-
-
Method Details
-
getUrlElement
- Specified by:
getUrlElement
in classCanonicalResource
- Returns:
url
(An absolute URI that is used to identify this compartment definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this compartment definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the compartment definition is stored on different servers.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
-
hasUrlElement
- Specified by:
hasUrlElement
in classCanonicalResource
-
hasUrl
- Specified by:
hasUrl
in classCanonicalResource
-
setUrlElement
- Specified by:
setUrlElement
in classCanonicalResource
- Parameters:
value
-url
(An absolute URI that is used to identify this compartment definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this compartment definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the compartment definition is stored on different servers.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
-
getUrl
- Specified by:
getUrl
in classCanonicalResource
- Returns:
- An absolute URI that is used to identify this compartment definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this compartment definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the compartment definition is stored on different servers.
-
setUrl
- Specified by:
setUrl
in classCanonicalResource
- Parameters:
value
- An absolute URI that is used to identify this compartment definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this compartment definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the compartment definition is stored on different servers.
-
getVersionElement
- Specified by:
getVersionElement
in classCanonicalResource
- Returns:
version
(The identifier that is used to identify this version of the compartment definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the compartment 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
- Specified by:
hasVersionElement
in classCanonicalResource
-
hasVersion
- Specified by:
hasVersion
in classCanonicalResource
-
setVersionElement
- Specified by:
setVersionElement
in classCanonicalResource
- Parameters:
value
-version
(The identifier that is used to identify this version of the compartment definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the compartment 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
- Specified by:
getVersion
in classCanonicalResource
- Returns:
- The identifier that is used to identify this version of the compartment definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the compartment 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
- Specified by:
setVersion
in classCanonicalResource
- Parameters:
value
- The identifier that is used to identify this version of the compartment definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the compartment 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
- Specified by:
getNameElement
in classCanonicalResource
- Returns:
name
(A natural language name identifying the compartment 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
- Specified by:
hasNameElement
in classCanonicalResource
-
hasName
- Specified by:
hasName
in classCanonicalResource
-
setNameElement
- Specified by:
setNameElement
in classCanonicalResource
- Parameters:
value
-name
(A natural language name identifying the compartment 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
- Specified by:
getName
in classCanonicalResource
- Returns:
- A natural language name identifying the compartment definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
setName
- Specified by:
setName
in classCanonicalResource
- Parameters:
value
- A natural language name identifying the compartment definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
getStatusElement
- Specified by:
getStatusElement
in classCanonicalResource
- Returns:
status
(The status of this compartment 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
- Specified by:
hasStatusElement
in classCanonicalResource
-
hasStatus
- Specified by:
hasStatus
in classCanonicalResource
-
setStatusElement
- Specified by:
setStatusElement
in classCanonicalResource
- Parameters:
value
-status
(The status of this compartment 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
- Specified by:
getStatus
in classCanonicalResource
- Returns:
- The status of this compartment definition. Enables tracking the life-cycle of the content.
-
setStatus
- Specified by:
setStatus
in classCanonicalResource
- Parameters:
value
- The status of this compartment definition. Enables tracking the life-cycle of the content.
-
getExperimentalElement
- Specified by:
getExperimentalElement
in classCanonicalResource
- Returns:
experimental
(A Boolean value to indicate that this compartment 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
- Specified by:
hasExperimentalElement
in classCanonicalResource
-
hasExperimental
- Specified by:
hasExperimental
in classCanonicalResource
-
setExperimentalElement
- Specified by:
setExperimentalElement
in classCanonicalResource
- Parameters:
value
-experimental
(A Boolean value to indicate that this compartment 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
- Specified by:
getExperimental
in classCanonicalResource
- Returns:
- A Boolean value to indicate that this compartment definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
-
setExperimental
- Specified by:
setExperimental
in classCanonicalResource
- Parameters:
value
- A Boolean value to indicate that this compartment definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
-
getDateElement
- Specified by:
getDateElement
in classCanonicalResource
- Returns:
date
(The date (and optionally time) when the compartment 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 compartment definition changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
-
hasDateElement
- Specified by:
hasDateElement
in classCanonicalResource
-
hasDate
- Specified by:
hasDate
in classCanonicalResource
-
setDateElement
- Specified by:
setDateElement
in classCanonicalResource
- Parameters:
value
-date
(The date (and optionally time) when the compartment 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 compartment definition changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
-
getDate
- Specified by:
getDate
in classCanonicalResource
- Returns:
- The date (and optionally time) when the compartment 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 compartment definition changes.
-
setDate
- Specified by:
setDate
in classCanonicalResource
- Parameters:
value
- The date (and optionally time) when the compartment 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 compartment definition changes.
-
getPublisherElement
- Specified by:
getPublisherElement
in classCanonicalResource
- Returns:
publisher
(The name of the organization or individual that published the compartment definition.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value
-
hasPublisherElement
- Specified by:
hasPublisherElement
in classCanonicalResource
-
hasPublisher
- Specified by:
hasPublisher
in classCanonicalResource
-
setPublisherElement
- Specified by:
setPublisherElement
in classCanonicalResource
- Parameters:
value
-publisher
(The name of the organization or individual that published the compartment definition.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value
-
getPublisher
- Specified by:
getPublisher
in classCanonicalResource
- Returns:
- The name of the organization or individual that published the compartment definition.
-
setPublisher
- Specified by:
setPublisher
in classCanonicalResource
- Parameters:
value
- The name of the organization or individual that published the compartment definition.
-
getContact
- Specified by:
getContact
in classCanonicalResource
- Returns:
contact
(Contact details to assist a user in finding and communicating with the publisher.)
-
setContact
- Specified by:
setContact
in classCanonicalResource
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasContact
- Specified by:
hasContact
in classCanonicalResource
-
addContact
- Specified by:
addContact
in classCanonicalResource
-
addContact
- Specified by:
addContact
in classCanonicalResource
-
getContactFirstRep
- Specified by:
getContactFirstRep
in classCanonicalResource
- Returns:
- The first repetition of repeating field
contact
, creating it if it does not already exist {3}
-
getDescriptionElement
- Specified by:
getDescriptionElement
in classCanonicalResource
- Returns:
description
(A free text natural language description of the compartment 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
- Specified by:
hasDescriptionElement
in classCanonicalResource
-
hasDescription
- Specified by:
hasDescription
in classCanonicalResource
-
setDescriptionElement
- Specified by:
setDescriptionElement
in classCanonicalResource
- Parameters:
value
-description
(A free text natural language description of the compartment 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
- Specified by:
getDescription
in classCanonicalResource
- Returns:
- A free text natural language description of the compartment definition from a consumer's perspective.
-
setDescription
- Specified by:
setDescription
in classCanonicalResource
- Parameters:
value
- A free text natural language description of the compartment definition from a consumer's perspective.
-
getUseContext
- Specified by:
getUseContext
in 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 compartment definition instances.)
-
setUseContext
- Specified by:
setUseContext
in classCanonicalResource
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasUseContext
- Specified by:
hasUseContext
in classCanonicalResource
-
addUseContext
- Specified by:
addUseContext
in classCanonicalResource
-
addUseContext
- Specified by:
addUseContext
in classCanonicalResource
-
getUseContextFirstRep
- Specified by:
getUseContextFirstRep
in classCanonicalResource
- Returns:
- The first repetition of repeating field
useContext
, creating it if it does not already exist {3}
-
getPurposeElement
- Specified by:
getPurposeElement
in classCanonicalResource
- Returns:
purpose
(Explanation of why this compartment 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
- Specified by:
hasPurposeElement
in classCanonicalResource
-
hasPurpose
- Specified by:
hasPurpose
in classCanonicalResource
-
setPurposeElement
- Specified by:
setPurposeElement
in classCanonicalResource
- Parameters:
value
-purpose
(Explanation of why this compartment 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
- Specified by:
getPurpose
in classCanonicalResource
- Returns:
- Explanation of why this compartment definition is needed and why it has been designed as it has.
-
setPurpose
- Specified by:
setPurpose
in classCanonicalResource
- Parameters:
value
- Explanation of why this compartment definition is needed and why it has been designed as it has.
-
getCodeElement
- Returns:
code
(Which compartment this definition describes.). This is the underlying object with id, value and extensions. The accessor "getCode" gives direct access to the value
-
hasCodeElement
-
hasCode
-
setCodeElement
- Parameters:
value
-code
(Which compartment this definition describes.). This is the underlying object with id, value and extensions. The accessor "getCode" gives direct access to the value
-
getCode
- Returns:
- Which compartment this definition describes.
-
setCode
- Parameters:
value
- Which compartment this definition describes.
-
getSearchElement
- Returns:
search
(Whether the search syntax is supported,.). This is the underlying object with id, value and extensions. The accessor "getSearch" gives direct access to the value
-
hasSearchElement
-
hasSearch
-
setSearchElement
- Parameters:
value
-search
(Whether the search syntax is supported,.). This is the underlying object with id, value and extensions. The accessor "getSearch" gives direct access to the value
-
getSearch
- Returns:
- Whether the search syntax is supported,.
-
setSearch
- Parameters:
value
- Whether the search syntax is supported,.
-
getResource
- Returns:
resource
(Information about how a resource is related to the compartment.)
-
setResource
public CompartmentDefinition setResource(List<CompartmentDefinition.CompartmentDefinitionResourceComponent> theResource) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasResource
-
addResource
-
addResource
-
getResourceFirstRep
- Returns:
- The first repetition of repeating field
resource
, creating it if it does not already exist {3}
-
getIdentifierMax
not supported on this implementation- Overrides:
getIdentifierMax
in classCanonicalResource
-
getIdentifier
- Specified by:
getIdentifier
in classCanonicalResource
- Returns:
#identifier
(A formal identifier that is used to identify this compartment definition when it is represented in other formats, or referenced in a specification, model, design or an instance.)
-
setIdentifier
- Specified by:
setIdentifier
in classCanonicalResource
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIdentifier
- Specified by:
hasIdentifier
in classCanonicalResource
-
addIdentifier
- Specified by:
addIdentifier
in classCanonicalResource
-
addIdentifier
- Specified by:
addIdentifier
in classCanonicalResource
-
getIdentifierFirstRep
- Specified by:
getIdentifierFirstRep
in classCanonicalResource
- Returns:
- The first repetition of repeating field
#identifier
, creating it if it does not already exist {2}
-
getTitleMax
not supported on this implementation- Overrides:
getTitleMax
in classCanonicalResource
-
getTitleElement
- Specified by:
getTitleElement
in classCanonicalResource
- Returns:
#title
(A short, descriptive, user-friendly title for the compartment definition.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
-
hasTitleElement
- Specified by:
hasTitleElement
in classCanonicalResource
-
hasTitle
- Specified by:
hasTitle
in classCanonicalResource
-
setTitleElement
- Specified by:
setTitleElement
in classCanonicalResource
- Parameters:
value
-#title
(A short, descriptive, user-friendly title for the compartment definition.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
-
getTitle
- Specified by:
getTitle
in classCanonicalResource
- Returns:
- A short, descriptive, user-friendly title for the canonical resource.
-
setTitle
- Specified by:
setTitle
in classCanonicalResource
- Parameters:
value
- A short, descriptive, user-friendly title for the compartment definition.
-
getJurisdictionMax
not supported on this implementation- Overrides:
getJurisdictionMax
in classCanonicalResource
-
getJurisdiction
- Specified by:
getJurisdiction
in classCanonicalResource
- Returns:
#jurisdiction
(A legal or geographic region in which the compartment definition is intended to be used.)
-
setJurisdiction
- Specified by:
setJurisdiction
in classCanonicalResource
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasJurisdiction
- Specified by:
hasJurisdiction
in classCanonicalResource
-
addJurisdiction
- Specified by:
addJurisdiction
in classCanonicalResource
-
addJurisdiction
- Specified by:
addJurisdiction
in classCanonicalResource
-
getJurisdictionFirstRep
- Specified by:
getJurisdictionFirstRep
in classCanonicalResource
- Returns:
- The first repetition of repeating field
#jurisdiction
, creating it if it does not already exist {2}
-
getCopyrightMax
not supported on this implementation- Overrides:
getCopyrightMax
in classCanonicalResource
-
getCopyrightElement
- Specified by:
getCopyrightElement
in classCanonicalResource
- Returns:
#copyright
(A copyright statement relating to the compartment definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the compartment definition.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value
-
hasCopyrightElement
- Specified by:
hasCopyrightElement
in classCanonicalResource
-
hasCopyright
- Specified by:
hasCopyright
in classCanonicalResource
-
setCopyrightElement
- Specified by:
setCopyrightElement
in classCanonicalResource
- Parameters:
value
-#copyright
(A copyright statement relating to the compartment definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the compartment definition.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value
-
getCopyright
- Specified by:
getCopyright
in classCanonicalResource
- Returns:
- A copyright statement relating to the canonical resource and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the canonical resource.
-
setCopyright
- Specified by:
setCopyright
in classCanonicalResource
- Parameters:
value
- A copyright statement relating to the compartment definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the compartment definition.
-
listChildren
- Overrides:
listChildren
in classCanonicalResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classCanonicalResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getProperty
in classCanonicalResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
setProperty
in classCanonicalResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classCanonicalResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classCanonicalResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classCanonicalResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classCanonicalResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classCanonicalResource
-
copy
- Specified by:
copy
in classCanonicalResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classCanonicalResource
-
equalsShallow
- Overrides:
equalsShallow
in classCanonicalResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classCanonicalResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-
supportsCopyright
- Overrides:
supportsCopyright
in classCanonicalResource
-