Uses of Class
com.ibm.fhir.model.type.Canonical

Packages that use Canonical

Package	Description
com.ibm.fhir.model.resource
com.ibm.fhir.model.type
com.ibm.fhir.model.visitor

Uses of Canonical in com.ibm.fhir.model.resource

Methods in com.ibm.fhir.model.resource that return Canonical

Modifier and Type	Method	Description
Canonical	Questionnaire.Item.getAnswerValueSet()	A reference to a value set containing a list of codes representing permitted answers for a "choice" or "open-choice" question.
Canonical	MessageDefinition.getBase()	The MessageDefinition that is the basis for the contents of this resource.
Canonical	OperationDefinition.getBase()	Indicates that this operation definition is a constraining profile on the base.
Canonical	StructureDefinition.getBaseDefinition()	An absolute URI that is the base structure from which this type is derived, either by specialization or constraint.
Canonical	TestScript.Metadata.Capability.getCapabilities()	Minimum capabilities required of server for test script to execute successfully.
Canonical	CapabilityStatement.Messaging.SupportedMessage.getDefinition()	Points to a message definition that identifies the messaging event, message structure, allowed responses, etc.
Canonical	CapabilityStatement.Rest.Resource.Operation.getDefinition()	Where the formal definition can be found.
Canonical	CapabilityStatement.Rest.Resource.SearchParam.getDefinition()	An absolute URI that is a formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter (a reference to [SearchParameter.url](searchparameter-definitions.
Canonical	MessageHeader.getDefinition()	Permanent link to the MessageDefinition for this message.
Canonical	SearchParameter.Component.getDefinition()	The definition of the search parameter that describes this part.
Canonical	SearchParameter.getDerivedFrom()	Where this search parameter is originally defined.
Canonical	OperationDefinition.getInputProfile()	Additional validation information for the in parameters - a single profile that covers all the parameters.
Canonical	Task.getInstantiatesCanonical()	The URL pointing to a *FHIR*-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.
Canonical	MeasureReport.getMeasure()	A reference to the Measure that was calculated to produce this report.
Canonical	MessageDefinition.AllowedResponse.getMessage()	A reference to the message definition that must be adhered to by this supported response.
Canonical	OperationDefinition.getOutputProfile()	Additional validation information for the out parameters - a single profile that covers all the parameters.
Canonical	ActivityDefinition.getProfile()	A profile to which the target of the activity definition is expected to conform.
Canonical	CapabilityStatement.Document.getProfile()	A profile on the document Bundle that constrains which resources are present, and their contents.
Canonical	CapabilityStatement.Rest.Resource.getProfile()	A specification of the profile that describes the solution's overall support for the resource, including any constraints on cardinality, bindings, lengths or other limitations.
Canonical	GraphDefinition.getProfile()	The profile that describes the use of the base resource.
Canonical	GraphDefinition.Link.Target.getProfile()	Profile for the target resource.
Canonical	ImplementationGuide.Global.getProfile()	A reference to the profile that all instances must conform to.
Canonical	MessageDefinition.Focus.getProfile()	A profile that reflects constraints for the focal resource (and potentially for related resources).
Canonical	QuestionnaireResponse.getQuestionnaire()	The Questionnaire that defines and organizes the questions for which answers are being provided.
Canonical	CodeSystem.getSupplements()	The canonical URL of the code system that this code system supplement is adding designations and properties to.
Canonical	ConceptMap.Group.Element.Target.DependsOn.getSystem()	An absolute URI that identifies the code system of the dependency code (if the source/dependency is a value set that crosses code systems).
Canonical	ActivityDefinition.getTransform()	A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.
Canonical	PlanDefinition.Action.getTransform()	A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.
Canonical	ImplementationGuide.DependsOn.getUri()	A canonical reference to the Implementation guide for the dependency.
Canonical	TerminologyCapabilities.CodeSystem.getUri()	URI for the Code System.
Canonical	ConceptMap.Group.Unmapped.getUrl()	The canonical reference to an additional ConceptMap resource instance to use for mapping if this ConceptMap resource contains no matching mapping for the source concept.
Canonical	StructureMap.Structure.getUrl()	The canonical reference to the structure.
Canonical	CodeSystem.getValueSet()	Canonical reference to the value set that contains the entire code system.
Canonical	OperationDefinition.Parameter.Binding.getValueSet()	Points to the value set or external definition (e.g.

Methods in com.ibm.fhir.model.resource that return types with arguments of type Canonical

Modifier and Type	Method	Description
List<Canonical>	CapabilityStatement.Rest.getCompartment()	An absolute URI which is a reference to the definition of a compartment that the system supports.
List<Canonical>	ChargeItem.getDefinitionCanonical()	References the source of pricing information, rules of application for the code this ChargeItem uses.
List<Canonical>	Questionnaire.getDerivedFrom()	The URL of a Questionnaire that this Questionnaire is based on.
List<Canonical>	MessageDefinition.getGraph()	Canonical reference to a GraphDefinition.
List<Canonical>	CapabilityStatement.getImplementationGuide()	A list of implementation guides that the server does (or should) support in their entirety.
List<Canonical>	StructureMap.getImport()	Other maps used by this map (canonical URLs).
List<Canonical>	CapabilityStatement.getImports()	Reference to a canonical URL of another CapabilityStatement that this software adds to.
List<Canonical>	CapabilityStatement.getInstantiates()	Reference to a canonical URL of another CapabilityStatement that this software implements.
List<Canonical>	CarePlan.Activity.Detail.getInstantiatesCanonical()	The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.
List<Canonical>	CarePlan.getInstantiatesCanonical()	The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.
List<Canonical>	Communication.getInstantiatesCanonical()	The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.
List<Canonical>	DeviceRequest.getInstantiatesCanonical()	The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.
List<Canonical>	FamilyMemberHistory.getInstantiatesCanonical()	The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.
List<Canonical>	MedicationRequest.getInstantiatesCanonical()	The URL pointing to a protocol, guideline, orderset, or other definition that is adhered to in whole or in part by this MedicationRequest.
List<Canonical>	NutritionOrder.getInstantiatesCanonical()	The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.
List<Canonical>	Procedure.getInstantiatesCanonical()	The URL pointing to a FHIR-defined protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.
List<Canonical>	RequestGroup.getInstantiatesCanonical()	A canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
List<Canonical>	ServiceRequest.getInstantiatesCanonical()	The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.
List<Canonical>	ActivityDefinition.getLibrary()	A reference to a Library resource containing any formal logic used by the activity definition.
List<Canonical>	Measure.getLibrary()	A reference to a Library resource containing the formal logic used by the measure.
List<Canonical>	PlanDefinition.getLibrary()	A reference to a Library resource containing any formal logic used by the plan definition.
List<Canonical>	ResearchDefinition.getLibrary()	A reference to a Library resource containing the formal logic used by the ResearchDefinition.
List<Canonical>	ResearchElementDefinition.getLibrary()	A reference to a Library resource containing the formal logic used by the ResearchElementDefinition.
List<Canonical>	MessageDefinition.getParent()	Identifies a protocol or workflow that this MessageDefinition represents a step in.
List<Canonical>	ChargeItemDefinition.getPartOf()	A larger definition of which this particular definition is a component or step.
List<Canonical>	ChargeItemDefinition.getReplaces()	As new versions of a protocol or guideline are defined, allows identification of what versions are replaced by a new instance.
List<Canonical>	MessageDefinition.getReplaces()	A MessageDefinition that is superseded by this definition.
List<Canonical>	CapabilityStatement.Rest.Resource.getSupportedProfile()	A list of profiles that represent different use cases supported by the system.
List<Canonical>	OperationDefinition.Parameter.getTargetProfile()	Used when the type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this parameter refers to.
List<Canonical>	ValueSet.Compose.Include.getValueSet()	Selects the concepts found in this value set (based on its value set definition).
List<Canonical>	ExampleScenario.getWorkflow()	Another nested workflow.

Methods in com.ibm.fhir.model.resource with parameters of type Canonical

Modifier and Type	Method	Description
StructureMap.Builder	StructureMap.Builder._import(Canonical... _import)	Other maps used by this map (canonical URLs).
Questionnaire.Item.Builder	Questionnaire.Item.Builder.answerValueSet(Canonical answerValueSet)	A reference to a value set containing a list of codes representing permitted answers for a "choice" or "open-choice" question.
MessageDefinition.Builder	MessageDefinition.Builder.base(Canonical base)	The MessageDefinition that is the basis for the contents of this resource.
OperationDefinition.Builder	OperationDefinition.Builder.base(Canonical base)	Indicates that this operation definition is a constraining profile on the base.
StructureDefinition.Builder	StructureDefinition.Builder.baseDefinition(Canonical baseDefinition)	An absolute URI that is the base structure from which this type is derived, either by specialization or constraint.
TestScript.Metadata.Capability.Builder	TestScript.Metadata.Capability.Builder.capabilities(Canonical capabilities)	Minimum capabilities required of server for test script to execute successfully.
CapabilityStatement.Rest.Builder	CapabilityStatement.Rest.Builder.compartment(Canonical... compartment)	An absolute URI which is a reference to the definition of a compartment that the system supports.
CapabilityStatement.Messaging.SupportedMessage.Builder	CapabilityStatement.Messaging.SupportedMessage.Builder.definition(Canonical definition)	Points to a message definition that identifies the messaging event, message structure, allowed responses, etc.
CapabilityStatement.Rest.Resource.Operation.Builder	CapabilityStatement.Rest.Resource.Operation.Builder.definition(Canonical definition)	Where the formal definition can be found.
CapabilityStatement.Rest.Resource.SearchParam.Builder	CapabilityStatement.Rest.Resource.SearchParam.Builder.definition(Canonical definition)	An absolute URI that is a formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter (a reference to [SearchParameter.url](searchparameter-definitions.
MessageHeader.Builder	MessageHeader.Builder.definition(Canonical definition)	Permanent link to the MessageDefinition for this message.
SearchParameter.Component.Builder	SearchParameter.Component.Builder.definition(Canonical definition)	The definition of the search parameter that describes this part.
ChargeItem.Builder	ChargeItem.Builder.definitionCanonical(Canonical... definitionCanonical)	References the source of pricing information, rules of application for the code this ChargeItem uses.
Questionnaire.Builder	Questionnaire.Builder.derivedFrom(Canonical... derivedFrom)	The URL of a Questionnaire that this Questionnaire is based on.
SearchParameter.Builder	SearchParameter.Builder.derivedFrom(Canonical derivedFrom)	Where this search parameter is originally defined.
MessageDefinition.Builder	MessageDefinition.Builder.graph(Canonical... graph)	Canonical reference to a GraphDefinition.
CapabilityStatement.Builder	CapabilityStatement.Builder.implementationGuide(Canonical... implementationGuide)	A list of implementation guides that the server does (or should) support in their entirety.
CapabilityStatement.Builder	CapabilityStatement.Builder.imports(Canonical... imports)	Reference to a canonical URL of another CapabilityStatement that this software adds to.
OperationDefinition.Builder	OperationDefinition.Builder.inputProfile(Canonical inputProfile)	Additional validation information for the in parameters - a single profile that covers all the parameters.
CapabilityStatement.Builder	CapabilityStatement.Builder.instantiates(Canonical... instantiates)	Reference to a canonical URL of another CapabilityStatement that this software implements.
CarePlan.Activity.Detail.Builder	CarePlan.Activity.Detail.Builder.instantiatesCanonical(Canonical... instantiatesCanonical)	The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.
CarePlan.Builder	CarePlan.Builder.instantiatesCanonical(Canonical... instantiatesCanonical)	The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.
Communication.Builder	Communication.Builder.instantiatesCanonical(Canonical... instantiatesCanonical)	The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.
DeviceRequest.Builder	DeviceRequest.Builder.instantiatesCanonical(Canonical... instantiatesCanonical)	The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.
FamilyMemberHistory.Builder	FamilyMemberHistory.Builder.instantiatesCanonical(Canonical... instantiatesCanonical)	The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.
MedicationRequest.Builder	MedicationRequest.Builder.instantiatesCanonical(Canonical... instantiatesCanonical)	The URL pointing to a protocol, guideline, orderset, or other definition that is adhered to in whole or in part by this MedicationRequest.
NutritionOrder.Builder	NutritionOrder.Builder.instantiatesCanonical(Canonical... instantiatesCanonical)	The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.
Procedure.Builder	Procedure.Builder.instantiatesCanonical(Canonical... instantiatesCanonical)	The URL pointing to a FHIR-defined protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.
RequestGroup.Builder	RequestGroup.Builder.instantiatesCanonical(Canonical... instantiatesCanonical)	A canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
ServiceRequest.Builder	ServiceRequest.Builder.instantiatesCanonical(Canonical... instantiatesCanonical)	The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.
Task.Builder	Task.Builder.instantiatesCanonical(Canonical instantiatesCanonical)	The URL pointing to a *FHIR*-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.
ActivityDefinition.Builder	ActivityDefinition.Builder.library(Canonical... library)	A reference to a Library resource containing any formal logic used by the activity definition.
Measure.Builder	Measure.Builder.library(Canonical... library)	A reference to a Library resource containing the formal logic used by the measure.
PlanDefinition.Builder	PlanDefinition.Builder.library(Canonical... library)	A reference to a Library resource containing any formal logic used by the plan definition.
ResearchDefinition.Builder	ResearchDefinition.Builder.library(Canonical... library)	A reference to a Library resource containing the formal logic used by the ResearchDefinition.
ResearchElementDefinition.Builder	ResearchElementDefinition.Builder.library(Canonical... library)	A reference to a Library resource containing the formal logic used by the ResearchElementDefinition.
MeasureReport.Builder	MeasureReport.Builder.measure(Canonical measure)	A reference to the Measure that was calculated to produce this report.
MessageDefinition.AllowedResponse.Builder	MessageDefinition.AllowedResponse.Builder.message(Canonical message)	A reference to the message definition that must be adhered to by this supported response.
OperationDefinition.Builder	OperationDefinition.Builder.outputProfile(Canonical outputProfile)	Additional validation information for the out parameters - a single profile that covers all the parameters.
MessageDefinition.Builder	MessageDefinition.Builder.parent(Canonical... parent)	Identifies a protocol or workflow that this MessageDefinition represents a step in.
ChargeItemDefinition.Builder	ChargeItemDefinition.Builder.partOf(Canonical... partOf)	A larger definition of which this particular definition is a component or step.
ActivityDefinition.Builder	ActivityDefinition.Builder.profile(Canonical profile)	A profile to which the target of the activity definition is expected to conform.
CapabilityStatement.Document.Builder	CapabilityStatement.Document.Builder.profile(Canonical profile)	A profile on the document Bundle that constrains which resources are present, and their contents.
CapabilityStatement.Rest.Resource.Builder	CapabilityStatement.Rest.Resource.Builder.profile(Canonical profile)	A specification of the profile that describes the solution's overall support for the resource, including any constraints on cardinality, bindings, lengths or other limitations.
GraphDefinition.Builder	GraphDefinition.Builder.profile(Canonical profile)	The profile that describes the use of the base resource.
GraphDefinition.Link.Target.Builder	GraphDefinition.Link.Target.Builder.profile(Canonical profile)	Profile for the target resource.
ImplementationGuide.Global.Builder	ImplementationGuide.Global.Builder.profile(Canonical profile)	A reference to the profile that all instances must conform to.
MessageDefinition.Focus.Builder	MessageDefinition.Focus.Builder.profile(Canonical profile)	A profile that reflects constraints for the focal resource (and potentially for related resources).
QuestionnaireResponse.Builder	QuestionnaireResponse.Builder.questionnaire(Canonical questionnaire)	The Questionnaire that defines and organizes the questions for which answers are being provided.
ChargeItemDefinition.Builder	ChargeItemDefinition.Builder.replaces(Canonical... replaces)	As new versions of a protocol or guideline are defined, allows identification of what versions are replaced by a new instance.
MessageDefinition.Builder	MessageDefinition.Builder.replaces(Canonical... replaces)	A MessageDefinition that is superseded by this definition.
CodeSystem.Builder	CodeSystem.Builder.supplements(Canonical supplements)	The canonical URL of the code system that this code system supplement is adding designations and properties to.
CapabilityStatement.Rest.Resource.Builder	CapabilityStatement.Rest.Resource.Builder.supportedProfile(Canonical... supportedProfile)	A list of profiles that represent different use cases supported by the system.
ConceptMap.Group.Element.Target.DependsOn.Builder	ConceptMap.Group.Element.Target.DependsOn.Builder.system(Canonical system)	An absolute URI that identifies the code system of the dependency code (if the source/dependency is a value set that crosses code systems).
OperationDefinition.Parameter.Builder	OperationDefinition.Parameter.Builder.targetProfile(Canonical... targetProfile)	Used when the type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this parameter refers to.
ActivityDefinition.Builder	ActivityDefinition.Builder.transform(Canonical transform)	A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.
PlanDefinition.Action.Builder	PlanDefinition.Action.Builder.transform(Canonical transform)	A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.
ImplementationGuide.DependsOn.Builder	ImplementationGuide.DependsOn.Builder.uri(Canonical uri)	A canonical reference to the Implementation guide for the dependency.
TerminologyCapabilities.CodeSystem.Builder	TerminologyCapabilities.CodeSystem.Builder.uri(Canonical uri)	URI for the Code System.
ConceptMap.Group.Unmapped.Builder	ConceptMap.Group.Unmapped.Builder.url(Canonical url)	The canonical reference to an additional ConceptMap resource instance to use for mapping if this ConceptMap resource contains no matching mapping for the source concept.
StructureMap.Structure.Builder	StructureMap.Structure.Builder.url(Canonical url)	The canonical reference to the structure.
CodeSystem.Builder	CodeSystem.Builder.valueSet(Canonical valueSet)	Canonical reference to the value set that contains the entire code system.
OperationDefinition.Parameter.Binding.Builder	OperationDefinition.Parameter.Binding.Builder.valueSet(Canonical valueSet)	Points to the value set or external definition (e.g.
ValueSet.Compose.Include.Builder	ValueSet.Compose.Include.Builder.valueSet(Canonical... valueSet)	Selects the concepts found in this value set (based on its value set definition).
ExampleScenario.Builder	ExampleScenario.Builder.workflow(Canonical... workflow)	Another nested workflow.

Method parameters in com.ibm.fhir.model.resource with type arguments of type Canonical

Modifier and Type	Method	Description
StructureMap.Builder	StructureMap.Builder._import(Collection<Canonical> _import)	Other maps used by this map (canonical URLs).
CapabilityStatement.Rest.Builder	CapabilityStatement.Rest.Builder.compartment(Collection<Canonical> compartment)	An absolute URI which is a reference to the definition of a compartment that the system supports.
ChargeItem.Builder	ChargeItem.Builder.definitionCanonical(Collection<Canonical> definitionCanonical)	References the source of pricing information, rules of application for the code this ChargeItem uses.
Questionnaire.Builder	Questionnaire.Builder.derivedFrom(Collection<Canonical> derivedFrom)	The URL of a Questionnaire that this Questionnaire is based on.
MessageDefinition.Builder	MessageDefinition.Builder.graph(Collection<Canonical> graph)	Canonical reference to a GraphDefinition.
CapabilityStatement.Builder	CapabilityStatement.Builder.implementationGuide(Collection<Canonical> implementationGuide)	A list of implementation guides that the server does (or should) support in their entirety.
CapabilityStatement.Builder	CapabilityStatement.Builder.imports(Collection<Canonical> imports)	Reference to a canonical URL of another CapabilityStatement that this software adds to.
CapabilityStatement.Builder	CapabilityStatement.Builder.instantiates(Collection<Canonical> instantiates)	Reference to a canonical URL of another CapabilityStatement that this software implements.
CarePlan.Activity.Detail.Builder	CarePlan.Activity.Detail.Builder.instantiatesCanonical(Collection<Canonical> instantiatesCanonical)	The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.
CarePlan.Builder	CarePlan.Builder.instantiatesCanonical(Collection<Canonical> instantiatesCanonical)	The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.
Communication.Builder	Communication.Builder.instantiatesCanonical(Collection<Canonical> instantiatesCanonical)	The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.
DeviceRequest.Builder	DeviceRequest.Builder.instantiatesCanonical(Collection<Canonical> instantiatesCanonical)	The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.
FamilyMemberHistory.Builder	FamilyMemberHistory.Builder.instantiatesCanonical(Collection<Canonical> instantiatesCanonical)	The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.
MedicationRequest.Builder	MedicationRequest.Builder.instantiatesCanonical(Collection<Canonical> instantiatesCanonical)	The URL pointing to a protocol, guideline, orderset, or other definition that is adhered to in whole or in part by this MedicationRequest.
NutritionOrder.Builder	NutritionOrder.Builder.instantiatesCanonical(Collection<Canonical> instantiatesCanonical)	The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.
Procedure.Builder	Procedure.Builder.instantiatesCanonical(Collection<Canonical> instantiatesCanonical)	The URL pointing to a FHIR-defined protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.
RequestGroup.Builder	RequestGroup.Builder.instantiatesCanonical(Collection<Canonical> instantiatesCanonical)	A canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
ServiceRequest.Builder	ServiceRequest.Builder.instantiatesCanonical(Collection<Canonical> instantiatesCanonical)	The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.
ActivityDefinition.Builder	ActivityDefinition.Builder.library(Collection<Canonical> library)	A reference to a Library resource containing any formal logic used by the activity definition.
Measure.Builder	Measure.Builder.library(Collection<Canonical> library)	A reference to a Library resource containing the formal logic used by the measure.
PlanDefinition.Builder	PlanDefinition.Builder.library(Collection<Canonical> library)	A reference to a Library resource containing any formal logic used by the plan definition.
ResearchDefinition.Builder	ResearchDefinition.Builder.library(Collection<Canonical> library)	A reference to a Library resource containing the formal logic used by the ResearchDefinition.
ResearchElementDefinition.Builder	ResearchElementDefinition.Builder.library(Collection<Canonical> library)	A reference to a Library resource containing the formal logic used by the ResearchElementDefinition.
MessageDefinition.Builder	MessageDefinition.Builder.parent(Collection<Canonical> parent)	Identifies a protocol or workflow that this MessageDefinition represents a step in.
ChargeItemDefinition.Builder	ChargeItemDefinition.Builder.partOf(Collection<Canonical> partOf)	A larger definition of which this particular definition is a component or step.
ChargeItemDefinition.Builder	ChargeItemDefinition.Builder.replaces(Collection<Canonical> replaces)	As new versions of a protocol or guideline are defined, allows identification of what versions are replaced by a new instance.
MessageDefinition.Builder	MessageDefinition.Builder.replaces(Collection<Canonical> replaces)	A MessageDefinition that is superseded by this definition.
CapabilityStatement.Rest.Resource.Builder	CapabilityStatement.Rest.Resource.Builder.supportedProfile(Collection<Canonical> supportedProfile)	A list of profiles that represent different use cases supported by the system.
OperationDefinition.Parameter.Builder	OperationDefinition.Parameter.Builder.targetProfile(Collection<Canonical> targetProfile)	Used when the type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this parameter refers to.
ValueSet.Compose.Include.Builder	ValueSet.Compose.Include.Builder.valueSet(Collection<Canonical> valueSet)	Selects the concepts found in this value set (based on its value set definition).
ExampleScenario.Builder	ExampleScenario.Builder.workflow(Collection<Canonical> workflow)	Another nested workflow.

Uses of Canonical in com.ibm.fhir.model.type

Methods in com.ibm.fhir.model.type that return Canonical

Modifier and Type	Method	Description
Canonical	Canonical.Builder.build()	Build the Canonical
Canonical	ParameterDefinition.getProfile()	If specified, this indicates a profile that the input data must conform to, or that the output data will conform to.
Canonical	RelatedArtifact.getResource()	The related resource, such as a library, value set, profile, or other knowledge resource.
Canonical	ElementDefinition.Constraint.getSource()	A reference to the original source of the constraint, for traceability purposes.
Canonical	DataRequirement.CodeFilter.getValueSet()	The valueset for the code filter.
Canonical	ElementDefinition.Binding.getValueSet()	Refers to the value set that identifies the set of codes the binding refers to.
static Canonical	Canonical.of(String value)
static Canonical	Canonical.of(String uri, String version)
static Canonical	Canonical.of(String uri, String version, String fragment)

Methods in com.ibm.fhir.model.type that return types with arguments of type Canonical

Modifier and Type	Method	Description
List<Canonical>	DataRequirement.getProfile()	The profile of the required data, specified as the uri of the profile definition.
List<Canonical>	ElementDefinition.Type.getProfile()	Identifies a profile structure or implementation Guide that applies to the datatype this element refers to.
List<Canonical>	Meta.getProfile()	A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to.
List<Canonical>	ElementDefinition.Type.getTargetProfile()	Used when the type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this element refers to.

Methods in com.ibm.fhir.model.type with parameters of type Canonical

Modifier and Type	Method	Description
protected Canonical.Builder	Canonical.Builder.from(Canonical canonical)
DataRequirement.Builder	DataRequirement.Builder.profile(Canonical... profile)	The profile of the required data, specified as the uri of the profile definition.
ElementDefinition.Type.Builder	ElementDefinition.Type.Builder.profile(Canonical... profile)	Identifies a profile structure or implementation Guide that applies to the datatype this element refers to.
Meta.Builder	Meta.Builder.profile(Canonical... profile)	A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to.
ParameterDefinition.Builder	ParameterDefinition.Builder.profile(Canonical profile)	If specified, this indicates a profile that the input data must conform to, or that the output data will conform to.
RelatedArtifact.Builder	RelatedArtifact.Builder.resource(Canonical resource)	The related resource, such as a library, value set, profile, or other knowledge resource.
ElementDefinition.Constraint.Builder	ElementDefinition.Constraint.Builder.source(Canonical source)	A reference to the original source of the constraint, for traceability purposes.
ElementDefinition.Type.Builder	ElementDefinition.Type.Builder.targetProfile(Canonical... targetProfile)	Used when the type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this element refers to.
DataRequirement.CodeFilter.Builder	DataRequirement.CodeFilter.Builder.valueSet(Canonical valueSet)	The valueset for the code filter.
ElementDefinition.Binding.Builder	ElementDefinition.Binding.Builder.valueSet(Canonical valueSet)	Refers to the value set that identifies the set of codes the binding refers to.

Method parameters in com.ibm.fhir.model.type with type arguments of type Canonical

Modifier and Type	Method	Description
DataRequirement.Builder	DataRequirement.Builder.profile(Collection<Canonical> profile)	The profile of the required data, specified as the uri of the profile definition.
ElementDefinition.Type.Builder	ElementDefinition.Type.Builder.profile(Collection<Canonical> profile)	Identifies a profile structure or implementation Guide that applies to the datatype this element refers to.
Meta.Builder	Meta.Builder.profile(Collection<Canonical> profile)	A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to.
ElementDefinition.Type.Builder	ElementDefinition.Type.Builder.targetProfile(Collection<Canonical> targetProfile)	Used when the type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this element refers to.

Uses of Canonical in com.ibm.fhir.model.visitor

Methods in com.ibm.fhir.model.visitor with parameters of type Canonical

Modifier and Type	Method	Description
boolean	DefaultVisitor.visit(String elementName, int elementIndex, Canonical canonical)	Delegates to #visit(elementName, elementIndex, Uri)
boolean	Visitor.visit(String elementName, int elementIndex, Canonical canonical)