Package org.hl7.fhir.r4.model

Class StructureMap

java.lang.Object

org.hl7.fhir.r4.model.Base

org.hl7.fhir.r4.model.BaseResource

org.hl7.fhir.r4.model.Resource

org.hl7.fhir.r4.model.DomainResource

org.hl7.fhir.r4.model.MetadataResource

org.hl7.fhir.r4.model.StructureMap

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

public class StructureMap
extends MetadataResource

A Map of relationships between 2 structures that can be used to transform data.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	StructureMap.StructureMapContextType
static class	StructureMap.StructureMapContextTypeEnumFactory
static class	StructureMap.StructureMapGroupComponent
static class	StructureMap.StructureMapGroupInputComponent
static class	StructureMap.StructureMapGroupRuleComponent
static class	StructureMap.StructureMapGroupRuleDependentComponent
static class	StructureMap.StructureMapGroupRuleSourceComponent
static class	StructureMap.StructureMapGroupRuleTargetComponent
static class	StructureMap.StructureMapGroupRuleTargetParameterComponent
static enum	StructureMap.StructureMapGroupTypeMode
static class	StructureMap.StructureMapGroupTypeModeEnumFactory
static enum	StructureMap.StructureMapInputMode
static class	StructureMap.StructureMapInputModeEnumFactory
static enum	StructureMap.StructureMapModelMode
static class	StructureMap.StructureMapModelModeEnumFactory
static enum	StructureMap.StructureMapSourceListMode
static class	StructureMap.StructureMapSourceListModeEnumFactory
static class	StructureMap.StructureMapStructureComponent
static enum	StructureMap.StructureMapTargetListMode
static class	StructureMap.StructureMapTargetListModeEnumFactory
static enum	StructureMap.StructureMapTransform
static class	StructureMap.StructureMapTransformEnumFactory

Field Summary

Fields

Modifier and Type	Field	Description
static final ca.uhn.fhir.rest.gclient.TokenClientParam	CONTEXT	Fluent Client search parameter constant for context
static final ca.uhn.fhir.rest.gclient.QuantityClientParam	CONTEXT_QUANTITY	Fluent Client search parameter constant for context-quantity
static final ca.uhn.fhir.rest.gclient.TokenClientParam	CONTEXT_TYPE	Fluent Client search parameter constant for context-type
static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.QuantityClientParam>	CONTEXT_TYPE_QUANTITY	Fluent Client search parameter constant for context-type-quantity
static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam>	CONTEXT_TYPE_VALUE	Fluent Client search parameter constant for context-type-value
protected MarkdownType	copyright	A copyright statement relating to the structure map and/or its contents.
static final ca.uhn.fhir.rest.gclient.DateClientParam	DATE	Fluent Client search parameter constant for date
static final ca.uhn.fhir.rest.gclient.StringClientParam	DESCRIPTION	Fluent Client search parameter constant for description
protected List<StructureMap.StructureMapGroupComponent>	group	Organizes the mapping into manageable chunks for human review/ease of maintenance.
protected List<Identifier>	identifier	A formal identifier that is used to identify this structure map when it is represented in other formats, or referenced in a specification, model, design or an instance.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
protected List<CanonicalType>	import_	Other maps used by this map (canonical URLs).
static final ca.uhn.fhir.rest.gclient.TokenClientParam	JURISDICTION	Fluent Client search parameter constant for jurisdiction
static final ca.uhn.fhir.rest.gclient.StringClientParam	NAME	Fluent Client search parameter constant for name
static final ca.uhn.fhir.rest.gclient.StringClientParam	PUBLISHER	Fluent Client search parameter constant for publisher
protected MarkdownType	purpose	Explanation of why this structure map is needed and why it has been designed as it has.
static final String	SP_CONTEXT	Search parameter: context
static final String	SP_CONTEXT_QUANTITY	Search parameter: context-quantity
static final String	SP_CONTEXT_TYPE	Search parameter: context-type
static final String	SP_CONTEXT_TYPE_QUANTITY	Search parameter: context-type-quantity
static final String	SP_CONTEXT_TYPE_VALUE	Search parameter: context-type-value
static final String	SP_DATE	Search parameter: date
static final String	SP_DESCRIPTION	Search parameter: description
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_JURISDICTION	Search parameter: jurisdiction
static final String	SP_NAME	Search parameter: name
static final String	SP_PUBLISHER	Search parameter: publisher
static final String	SP_STATUS	Search parameter: status
static final String	SP_TITLE	Search parameter: title
static final String	SP_URL	Search parameter: url
static final String	SP_VERSION	Search parameter: version
static final ca.uhn.fhir.rest.gclient.TokenClientParam	STATUS	Fluent Client search parameter constant for status
protected List<StructureMap.StructureMapStructureComponent>	structure	A structure definition used by this map.
static final ca.uhn.fhir.rest.gclient.StringClientParam	TITLE	Fluent Client search parameter constant for title
static final ca.uhn.fhir.rest.gclient.UriClientParam	URL	Fluent Client search parameter constant for url
static final ca.uhn.fhir.rest.gclient.TokenClientParam	VERSION	Fluent Client search parameter constant for version

Fields inherited from class org.hl7.fhir.r4.model.MetadataResource

contact, date, description, experimental, jurisdiction, name, publisher, status, title, url, useContext, version

Fields inherited from class org.hl7.fhir.r4.model.DomainResource

contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.r4.model.Resource

id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
StructureMap()	Constructor
StructureMap(UriType url, StringType name, Enumeration<Enumerations.PublicationStatus> status)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
ContactDetail	addContact()
StructureMap	addContact(ContactDetail t)
StructureMap.StructureMapGroupComponent	addGroup()
StructureMap	addGroup(StructureMap.StructureMapGroupComponent t)
Identifier	addIdentifier()
StructureMap	addIdentifier(Identifier t)
StructureMap	addImport(String value)
CanonicalType	addImportElement()
CodeableConcept	addJurisdiction()
StructureMap	addJurisdiction(CodeableConcept t)
StructureMap.StructureMapStructureComponent	addStructure()
StructureMap	addStructure(StructureMap.StructureMapStructureComponent t)
UsageContext	addUseContext()
StructureMap	addUseContext(UsageContext t)
StructureMap	copy()
void	copyValues(StructureMap dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<ContactDetail>	getContact()
ContactDetail	getContactFirstRep()
String	getCopyright()
MarkdownType	getCopyrightElement()
Date	getDate()
DateTimeType	getDateElement()
String	getDescription()
MarkdownType	getDescriptionElement()
boolean	getExperimental()
BooleanType	getExperimentalElement()
List<StructureMap.StructureMapGroupComponent>	getGroup()
StructureMap.StructureMapGroupComponent	getGroupFirstRep()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
List<CanonicalType>	getImport()
List<CodeableConcept>	getJurisdiction()
CodeableConcept	getJurisdictionFirstRep()
String	getName()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
StringType	getNameElement()
Base[]	getProperty(int hash, String name, boolean checkValid)
String	getPublisher()
StringType	getPublisherElement()
String	getPurpose()
MarkdownType	getPurposeElement()
ResourceType	getResourceType()
Enumerations.PublicationStatus	getStatus()
Enumeration<Enumerations.PublicationStatus>	getStatusElement()
List<StructureMap.StructureMapStructureComponent>	getStructure()
StructureMap.StructureMapStructureComponent	getStructureFirstRep()
String	getTitle()
StringType	getTitleElement()
String[]	getTypesForProperty(int hash, String name)
String	getUrl()
UriType	getUrlElement()
List<UsageContext>	getUseContext()
UsageContext	getUseContextFirstRep()
String	getVersion()
StringType	getVersionElement()
boolean	hasContact()
boolean	hasCopyright()
boolean	hasCopyrightElement()
boolean	hasDate()
boolean	hasDateElement()
boolean	hasDescription()
boolean	hasDescriptionElement()
boolean	hasExperimental()
boolean	hasExperimentalElement()
boolean	hasGroup()
boolean	hasIdentifier()
boolean	hasImport()
boolean	hasImport(String value)
boolean	hasJurisdiction()
boolean	hasName()
boolean	hasNameElement()
boolean	hasPublisher()
boolean	hasPublisherElement()
boolean	hasPurpose()
boolean	hasPurposeElement()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasStructure()
boolean	hasTitle()
boolean	hasTitleElement()
boolean	hasUrl()
boolean	hasUrlElement()
boolean	hasUseContext()
boolean	hasVersion()
boolean	hasVersionElement()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
StructureMap	setContact(List<ContactDetail> theContact)
StructureMap	setCopyright(String value)
StructureMap	setCopyrightElement(MarkdownType value)
StructureMap	setDate(Date value)
StructureMap	setDateElement(DateTimeType value)
StructureMap	setDescription(String value)
StructureMap	setDescriptionElement(MarkdownType value)
StructureMap	setExperimental(boolean value)
StructureMap	setExperimentalElement(BooleanType value)
StructureMap	setGroup(List<StructureMap.StructureMapGroupComponent> theGroup)
StructureMap	setIdentifier(List<Identifier> theIdentifier)
StructureMap	setImport(List<CanonicalType> theImport)
StructureMap	setJurisdiction(List<CodeableConcept> theJurisdiction)
StructureMap	setName(String value)
StructureMap	setNameElement(StringType value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
StructureMap	setPublisher(String value)
StructureMap	setPublisherElement(StringType value)
StructureMap	setPurpose(String value)
StructureMap	setPurposeElement(MarkdownType value)
StructureMap	setStatus(Enumerations.PublicationStatus value)
StructureMap	setStatusElement(Enumeration<Enumerations.PublicationStatus> value)
StructureMap	setStructure(List<StructureMap.StructureMapStructureComponent> theStructure)
StructureMap	setTitle(String value)
StructureMap	setTitleElement(StringType value)
StructureMap	setUrl(String value)
StructureMap	setUrlElement(UriType value)
StructureMap	setUseContext(List<UsageContext> theUseContext)
StructureMap	setVersion(String value)
StructureMap	setVersionElement(StringType value)
String	toString()
protected StructureMap	typedCopy()

Methods inherited from class org.hl7.fhir.r4.model.MetadataResource

copyValues, present

Methods inherited from class org.hl7.fhir.r4.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.r4.model.Resource

copyValues, getId, getIdBase, getIdElement, getIdPart, 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.r4.model.BaseResource

getStructureFhirVersionEnum, isResource, setId

Methods inherited from class org.hl7.fhir.r4.model.Base

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, 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, isDeleted, setId

Field Details

identifier

protected List<Identifier> identifier

A formal identifier that is used to identify this structure map when it is represented in other formats, or referenced in a specification, model, design or an instance.

purpose

protected MarkdownType purpose

Explanation of why this structure map is needed and why it has been designed as it has.

copyright

protected MarkdownType copyright

A copyright statement relating to the structure map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the structure map.

structure

protected List<StructureMap.StructureMapStructureComponent> structure

A structure definition used by this map. The structure definition may describe instances that are converted, or the instances that are produced.

import_

protected List<CanonicalType> import_

Other maps used by this map (canonical URLs).

group

protected List<StructureMap.StructureMapGroupComponent> group

Organizes the mapping into manageable chunks for human review/ease of maintenance.

SP_DATE

public static final String SP_DATE

Search parameter: date

Description: The structure map publication date
Type: date
Path: StructureMap.date

See Also:

• Constant Field Values

DATE

public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE

Fluent Client search parameter constant for date

Description: The structure map publication date
Type: date
Path: StructureMap.date

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: External identifier for the structure map
Type: token
Path: StructureMap.identifier

See Also:

• Constant Field Values

IDENTIFIER

public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER

Fluent Client search parameter constant for identifier

Description: External identifier for the structure map
Type: token
Path: StructureMap.identifier

SP_CONTEXT_TYPE_VALUE

public static final String SP_CONTEXT_TYPE_VALUE

Search parameter: context-type-value

Description: A use context type and value assigned to the structure map
Type: composite
Path:

See Also:

• Constant Field Values

CONTEXT_TYPE_VALUE

public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam> CONTEXT_TYPE_VALUE

Fluent Client search parameter constant for context-type-value

Description: A use context type and value assigned to the structure map
Type: composite
Path:

SP_JURISDICTION

public static final String SP_JURISDICTION

Search parameter: jurisdiction

Description: Intended jurisdiction for the structure map
Type: token
Path: StructureMap.jurisdiction

See Also:

• Constant Field Values

JURISDICTION

public static final ca.uhn.fhir.rest.gclient.TokenClientParam JURISDICTION

Fluent Client search parameter constant for jurisdiction

Description: Intended jurisdiction for the structure map
Type: token
Path: StructureMap.jurisdiction

SP_DESCRIPTION

public static final String SP_DESCRIPTION

Search parameter: description

Description: The description of the structure map
Type: string
Path: StructureMap.description

See Also:

• Constant Field Values

DESCRIPTION

public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION

Fluent Client search parameter constant for description

Description: The description of the structure map
Type: string
Path: StructureMap.description

SP_CONTEXT_TYPE

public static final String SP_CONTEXT_TYPE

Search parameter: context-type

Description: A type of use context assigned to the structure map
Type: token
Path: StructureMap.useContext.code

See Also:

• Constant Field Values

CONTEXT_TYPE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT_TYPE

Fluent Client search parameter constant for context-type

Description: A type of use context assigned to the structure map
Type: token
Path: StructureMap.useContext.code

SP_TITLE

public static final String SP_TITLE

Search parameter: title

Description: The human-friendly name of the structure map
Type: string
Path: StructureMap.title

See Also:

• Constant Field Values

TITLE

public static final ca.uhn.fhir.rest.gclient.StringClientParam TITLE

Fluent Client search parameter constant for title

Description: The human-friendly name of the structure map
Type: string
Path: StructureMap.title

SP_VERSION

public static final String SP_VERSION

Search parameter: version

Description: The business version of the structure map
Type: token
Path: StructureMap.version

See Also:

• Constant Field Values

VERSION

public static final ca.uhn.fhir.rest.gclient.TokenClientParam VERSION

Fluent Client search parameter constant for version

Description: The business version of the structure map
Type: token
Path: StructureMap.version

SP_URL

public static final String SP_URL

Search parameter: url

Description: The uri that identifies the structure map
Type: uri
Path: StructureMap.url

See Also:

• Constant Field Values

URL

public static final ca.uhn.fhir.rest.gclient.UriClientParam URL

Fluent Client search parameter constant for url

Description: The uri that identifies the structure map
Type: uri
Path: StructureMap.url

SP_CONTEXT_QUANTITY

public static final String SP_CONTEXT_QUANTITY

Search parameter: context-quantity

Description: A quantity- or range-valued use context assigned to the structure map
Type: quantity
Path: StructureMap.useContext.valueQuantity, StructureMap.useContext.valueRange

See Also:

• Constant Field Values

CONTEXT_QUANTITY

public static final ca.uhn.fhir.rest.gclient.QuantityClientParam CONTEXT_QUANTITY

Fluent Client search parameter constant for context-quantity

Description: A quantity- or range-valued use context assigned to the structure map
Type: quantity
Path: StructureMap.useContext.valueQuantity, StructureMap.useContext.valueRange

SP_NAME

public static final String SP_NAME

Search parameter: name

Description: Computationally friendly name of the structure map
Type: string
Path: StructureMap.name

See Also:

• Constant Field Values

NAME

public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME

Fluent Client search parameter constant for name

Description: Computationally friendly name of the structure map
Type: string
Path: StructureMap.name

SP_CONTEXT

public static final String SP_CONTEXT

Search parameter: context

Description: A use context assigned to the structure map
Type: token
Path: StructureMap.useContext.valueCodeableConcept

See Also:

• Constant Field Values

CONTEXT

public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT

Fluent Client search parameter constant for context

Description: A use context assigned to the structure map
Type: token
Path: StructureMap.useContext.valueCodeableConcept

SP_PUBLISHER

public static final String SP_PUBLISHER

Search parameter: publisher

Description: Name of the publisher of the structure map
Type: string
Path: StructureMap.publisher

See Also:

• Constant Field Values

PUBLISHER

public static final ca.uhn.fhir.rest.gclient.StringClientParam PUBLISHER

Fluent Client search parameter constant for publisher

Description: Name of the publisher of the structure map
Type: string
Path: StructureMap.publisher

SP_CONTEXT_TYPE_QUANTITY

public static final String SP_CONTEXT_TYPE_QUANTITY

Search parameter: context-type-quantity

Description: A use context type and quantity- or range-based value assigned to the structure map
Type: composite
Path:

See Also:

• Constant Field Values

CONTEXT_TYPE_QUANTITY

public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.QuantityClientParam> CONTEXT_TYPE_QUANTITY

Fluent Client search parameter constant for context-type-quantity

Description: A use context type and quantity- or range-based value assigned to the structure map
Type: composite
Path:

SP_STATUS

public static final String SP_STATUS

Search parameter: status

Description: The current status of the structure map
Type: token
Path: StructureMap.status

See Also:

• Constant Field Values

STATUS

public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS

Fluent Client search parameter constant for status

Description: The current status of the structure map
Type: token
Path: StructureMap.status

Constructor Details

StructureMap

public StructureMap()

Constructor

StructureMap

public StructureMap(UriType url,
 StringType name,
 Enumeration<Enumerations.PublicationStatus> status)

Constructor

Method Details

getUrlElement

public UriType getUrlElement()

Overrides:

getUrlElement in class MetadataResource

Returns:

MetadataResource.url (An absolute URI that is used to identify this structure map 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 structure map is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the structure map 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

public boolean hasUrlElement()

Overrides:

hasUrlElement in class MetadataResource

hasUrl

public boolean hasUrl()

Overrides:

hasUrl in class MetadataResource

setUrlElement

public StructureMap setUrlElement(UriType value)

Overrides:

setUrlElement in class MetadataResource

Parameters:

value - MetadataResource.url (An absolute URI that is used to identify this structure map 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 structure map is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the structure map 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

public String getUrl()

Overrides:

getUrl in class MetadataResource

Returns:

An absolute URI that is used to identify this structure map 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 structure map is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the structure map is stored on different servers.

setUrl

public StructureMap setUrl(String value)

Overrides:

setUrl in class MetadataResource

Parameters:

value - An absolute URI that is used to identify this structure map 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 structure map is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the structure map is stored on different servers.

getIdentifier

public List<Identifier> getIdentifier()

Returns:

identifier (A formal identifier that is used to identify this structure map when it is represented in other formats, or referenced in a specification, model, design or an instance.)

setIdentifier

public StructureMap setIdentifier(List<Identifier> theIdentifier)

Returns:

Returns a reference to this for easy method chaining

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

addIdentifier

public StructureMap addIdentifier(Identifier t)

getIdentifierFirstRep

public Identifier getIdentifierFirstRep()

Returns:

The first repetition of repeating field identifier, creating it if it does not already exist

getVersionElement

public StringType getVersionElement()

Overrides:

getVersionElement in class MetadataResource

Returns:

MetadataResource.version (The identifier that is used to identify this version of the structure map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure map author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value

hasVersionElement

public boolean hasVersionElement()

Overrides:

hasVersionElement in class MetadataResource

hasVersion

public boolean hasVersion()

Overrides:

hasVersion in class MetadataResource

setVersionElement

public StructureMap setVersionElement(StringType value)

Overrides:

setVersionElement in class MetadataResource

Parameters:

value - MetadataResource.version (The identifier that is used to identify this version of the structure map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure map author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value

getVersion

public String getVersion()

Overrides:

getVersion in class MetadataResource

Returns:

The identifier that is used to identify this version of the structure map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure map author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

setVersion

public StructureMap setVersion(String value)

Overrides:

setVersion in class MetadataResource

Parameters:

value - The identifier that is used to identify this version of the structure map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure map author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

getNameElement

public StringType getNameElement()

Overrides:

getNameElement in class MetadataResource

Returns:

MetadataResource.name (A natural language name identifying the structure map. This name should be usable as an identifier for the module by machine processing applications such as code generation.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value

hasNameElement

public boolean hasNameElement()

Overrides:

hasNameElement in class MetadataResource

hasName

public boolean hasName()

Overrides:

hasName in class MetadataResource

setNameElement

public StructureMap setNameElement(StringType value)

Overrides:

setNameElement in class MetadataResource

Parameters:

value - MetadataResource.name (A natural language name identifying the structure map. This name should be usable as an identifier for the module by machine processing applications such as code generation.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value

getName

public String getName()

Overrides:

getName in class MetadataResource

Returns:

A natural language name identifying the structure map. This name should be usable as an identifier for the module by machine processing applications such as code generation.

setName

public StructureMap setName(String value)

Overrides:

setName in class MetadataResource

Parameters:

value - A natural language name identifying the structure map. This name should be usable as an identifier for the module by machine processing applications such as code generation.

getTitleElement

public StringType getTitleElement()

Overrides:

getTitleElement in class MetadataResource

Returns:

MetadataResource.title (A short, descriptive, user-friendly title for the structure map.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value

hasTitleElement

public boolean hasTitleElement()

Overrides:

hasTitleElement in class MetadataResource

hasTitle

public boolean hasTitle()

Overrides:

hasTitle in class MetadataResource

setTitleElement

public StructureMap setTitleElement(StringType value)

Overrides:

setTitleElement in class MetadataResource

Parameters:

value - MetadataResource.title (A short, descriptive, user-friendly title for the structure map.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value

getTitle

public String getTitle()

Overrides:

getTitle in class MetadataResource

Returns:

A short, descriptive, user-friendly title for the structure map.

setTitle

public StructureMap setTitle(String value)

Overrides:

setTitle in class MetadataResource

Parameters:

value - A short, descriptive, user-friendly title for the structure map.

getStatusElement

public Enumeration<Enumerations.PublicationStatus> getStatusElement()

Overrides:

getStatusElement in class MetadataResource

Returns:

MetadataResource.status (The status of this structure map. Enables tracking the life-cycle of the content.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

hasStatusElement

public boolean hasStatusElement()

Overrides:

hasStatusElement in class MetadataResource

hasStatus

public boolean hasStatus()

Overrides:

hasStatus in class MetadataResource

setStatusElement

public StructureMap setStatusElement(Enumeration<Enumerations.PublicationStatus> value)

Overrides:

setStatusElement in class MetadataResource

Parameters:

value - MetadataResource.status (The status of this structure map. Enables tracking the life-cycle of the content.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

getStatus

public Enumerations.PublicationStatus getStatus()

Overrides:

getStatus in class MetadataResource

Returns:

The status of this structure map. Enables tracking the life-cycle of the content.

setStatus

public StructureMap setStatus(Enumerations.PublicationStatus value)

Overrides:

setStatus in class MetadataResource

Parameters:

value - The status of this structure map. Enables tracking the life-cycle of the content.

getExperimentalElement

public BooleanType getExperimentalElement()

Overrides:

getExperimentalElement in class MetadataResource

Returns:

MetadataResource.experimental (A Boolean value to indicate that this structure map is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value

hasExperimentalElement

public boolean hasExperimentalElement()

Overrides:

hasExperimentalElement in class MetadataResource

hasExperimental

public boolean hasExperimental()

Overrides:

hasExperimental in class MetadataResource

setExperimentalElement

public StructureMap setExperimentalElement(BooleanType value)

Overrides:

setExperimentalElement in class MetadataResource

Parameters:

value - MetadataResource.experimental (A Boolean value to indicate that this structure map is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value

getExperimental

public boolean getExperimental()

Overrides:

getExperimental in class MetadataResource

Returns:

A Boolean value to indicate that this structure map is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

setExperimental

public StructureMap setExperimental(boolean value)

Overrides:

setExperimental in class MetadataResource

Parameters:

value - A Boolean value to indicate that this structure map is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

getDateElement

public DateTimeType getDateElement()

Overrides:

getDateElement in class MetadataResource

Returns:

MetadataResource.date (The date (and optionally time) when the structure map 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 structure map changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value

hasDateElement

public boolean hasDateElement()

Overrides:

hasDateElement in class MetadataResource

hasDate

public boolean hasDate()

Overrides:

hasDate in class MetadataResource

setDateElement

public StructureMap setDateElement(DateTimeType value)

Overrides:

setDateElement in class MetadataResource

Parameters:

value - MetadataResource.date (The date (and optionally time) when the structure map 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 structure map changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value

getDate

public Date getDate()

Overrides:

getDate in class MetadataResource

Returns:

The date (and optionally time) when the structure map 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 structure map changes.

setDate

public StructureMap setDate(Date value)

Overrides:

setDate in class MetadataResource

Parameters:

value - The date (and optionally time) when the structure map 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 structure map changes.

getPublisherElement

public StringType getPublisherElement()

Overrides:

getPublisherElement in class MetadataResource

Returns:

MetadataResource.publisher (The name of the organization or individual that published the structure map.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value

hasPublisherElement

public boolean hasPublisherElement()

Overrides:

hasPublisherElement in class MetadataResource

hasPublisher

public boolean hasPublisher()

Overrides:

hasPublisher in class MetadataResource

setPublisherElement

public StructureMap setPublisherElement(StringType value)

Overrides:

setPublisherElement in class MetadataResource

Parameters:

value - MetadataResource.publisher (The name of the organization or individual that published the structure map.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value

getPublisher

public String getPublisher()

Overrides:

getPublisher in class MetadataResource

Returns:

The name of the organization or individual that published the structure map.

setPublisher

public StructureMap setPublisher(String value)

Overrides:

setPublisher in class MetadataResource

Parameters:

value - The name of the organization or individual that published the structure map.

getContact

public List<ContactDetail> getContact()

Overrides:

getContact in class MetadataResource

Returns:

MetadataResource.contact (Contact details to assist a user in finding and communicating with the publisher.)

setContact

public StructureMap setContact(List<ContactDetail> theContact)

Overrides:

setContact in class MetadataResource

Returns:

Returns a reference to this for easy method chaining

hasContact

public boolean hasContact()

Overrides:

hasContact in class MetadataResource

addContact

public ContactDetail addContact()

Overrides:

addContact in class MetadataResource

addContact

public StructureMap addContact(ContactDetail t)

Overrides:

addContact in class MetadataResource

getContactFirstRep

public ContactDetail getContactFirstRep()

Overrides:

getContactFirstRep in class MetadataResource

Returns:

The first repetition of repeating field MetadataResource.contact, creating it if it does not already exist

getDescriptionElement

public MarkdownType getDescriptionElement()

Overrides:

getDescriptionElement in class MetadataResource

Returns:

MetadataResource.description (A free text natural language description of the structure map from a consumer's perspective.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

hasDescriptionElement

public boolean hasDescriptionElement()

Overrides:

hasDescriptionElement in class MetadataResource

hasDescription

public boolean hasDescription()

Overrides:

hasDescription in class MetadataResource

setDescriptionElement

public StructureMap setDescriptionElement(MarkdownType value)

Overrides:

setDescriptionElement in class MetadataResource

Parameters:

value - MetadataResource.description (A free text natural language description of the structure map from a consumer's perspective.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

getDescription

public String getDescription()

Overrides:

getDescription in class MetadataResource

Returns:

A free text natural language description of the structure map from a consumer's perspective.

setDescription

public StructureMap setDescription(String value)

Overrides:

setDescription in class MetadataResource

Parameters:

value - A free text natural language description of the structure map from a consumer's perspective.

getUseContext

public List<UsageContext> getUseContext()

Overrides:

getUseContext in class MetadataResource

Returns:

MetadataResource.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 structure map instances.)

setUseContext

public StructureMap setUseContext(List<UsageContext> theUseContext)

Overrides:

setUseContext in class MetadataResource

Returns:

Returns a reference to this for easy method chaining

hasUseContext

public boolean hasUseContext()

Overrides:

hasUseContext in class MetadataResource

addUseContext

public UsageContext addUseContext()

Overrides:

addUseContext in class MetadataResource

addUseContext

public StructureMap addUseContext(UsageContext t)

Overrides:

addUseContext in class MetadataResource

getUseContextFirstRep

public UsageContext getUseContextFirstRep()

Overrides:

getUseContextFirstRep in class MetadataResource

Returns:

The first repetition of repeating field MetadataResource.useContext, creating it if it does not already exist

getJurisdiction

public List<CodeableConcept> getJurisdiction()

Overrides:

getJurisdiction in class MetadataResource

Returns:

MetadataResource.jurisdiction (A legal or geographic region in which the structure map is intended to be used.)

setJurisdiction

public StructureMap setJurisdiction(List<CodeableConcept> theJurisdiction)

Overrides:

setJurisdiction in class MetadataResource

Returns:

Returns a reference to this for easy method chaining

hasJurisdiction

public boolean hasJurisdiction()

Overrides:

hasJurisdiction in class MetadataResource

addJurisdiction

public CodeableConcept addJurisdiction()

Overrides:

addJurisdiction in class MetadataResource

addJurisdiction

public StructureMap addJurisdiction(CodeableConcept t)

Overrides:

addJurisdiction in class MetadataResource

getJurisdictionFirstRep

public CodeableConcept getJurisdictionFirstRep()

Overrides:

getJurisdictionFirstRep in class MetadataResource

Returns:

The first repetition of repeating field MetadataResource.jurisdiction, creating it if it does not already exist

getPurposeElement

public MarkdownType getPurposeElement()

Returns:

purpose (Explanation of why this structure map is needed and why it has been designed as it has.). This is the underlying object with id, value and extensions. The accessor "getPurpose" gives direct access to the value

hasPurposeElement

public boolean hasPurposeElement()

hasPurpose

public boolean hasPurpose()

setPurposeElement

public StructureMap setPurposeElement(MarkdownType value)

Parameters:

value - purpose (Explanation of why this structure map is needed and why it has been designed as it has.). This is the underlying object with id, value and extensions. The accessor "getPurpose" gives direct access to the value

getPurpose

public String getPurpose()

Returns:

Explanation of why this structure map is needed and why it has been designed as it has.

setPurpose

public StructureMap setPurpose(String value)

Parameters:

value - Explanation of why this structure map is needed and why it has been designed as it has.

getCopyrightElement

public MarkdownType getCopyrightElement()

Returns:

copyright (A copyright statement relating to the structure map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the structure map.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value

hasCopyrightElement

public boolean hasCopyrightElement()

hasCopyright

public boolean hasCopyright()

setCopyrightElement

public StructureMap setCopyrightElement(MarkdownType value)

Parameters:

value - copyright (A copyright statement relating to the structure map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the structure map.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value

getCopyright

public String getCopyright()

Returns:

A copyright statement relating to the structure map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the structure map.

setCopyright

public StructureMap setCopyright(String value)

Parameters:

value - A copyright statement relating to the structure map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the structure map.

getStructure

public List<StructureMap.StructureMapStructureComponent> getStructure()

Returns:

structure (A structure definition used by this map. The structure definition may describe instances that are converted, or the instances that are produced.)

setStructure

public StructureMap setStructure(List<StructureMap.StructureMapStructureComponent> theStructure)

Returns:

Returns a reference to this for easy method chaining

hasStructure

public boolean hasStructure()

addStructure

public StructureMap.StructureMapStructureComponent addStructure()

addStructure

public StructureMap addStructure(StructureMap.StructureMapStructureComponent t)

getStructureFirstRep

public StructureMap.StructureMapStructureComponent getStructureFirstRep()

Returns:

The first repetition of repeating field structure, creating it if it does not already exist

getImport

public List<CanonicalType> getImport()

Returns:

import_ (Other maps used by this map (canonical URLs).)

setImport

public StructureMap setImport(List<CanonicalType> theImport)

Returns:

Returns a reference to this for easy method chaining

hasImport

public boolean hasImport()

addImportElement

public CanonicalType addImportElement()

Returns:

import_ (Other maps used by this map (canonical URLs).)

addImport

public StructureMap addImport(String value)

Parameters:

value - import_ (Other maps used by this map (canonical URLs).)

hasImport

public boolean hasImport(String value)

Parameters:

value - import_ (Other maps used by this map (canonical URLs).)

getGroup

public List<StructureMap.StructureMapGroupComponent> getGroup()

Returns:

group (Organizes the mapping into manageable chunks for human review/ease of maintenance.)

setGroup

public StructureMap setGroup(List<StructureMap.StructureMapGroupComponent> theGroup)

Returns:

Returns a reference to this for easy method chaining

hasGroup

public boolean hasGroup()

addGroup

public StructureMap.StructureMapGroupComponent addGroup()

addGroup

public StructureMap addGroup(StructureMap.StructureMapGroupComponent t)

getGroupFirstRep

public StructureMap.StructureMapGroupComponent getGroupFirstRep()

Returns:

The first repetition of repeating field group, creating it if it does not already exist

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class MetadataResource

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class DomainResource

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 class MetadataResource

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 class MetadataResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class MetadataResource

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

public void removeChild(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

removeChild in class MetadataResource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class MetadataResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class MetadataResource

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class MetadataResource

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class MetadataResource

copy

public StructureMap copy()

Specified by:

copy in class MetadataResource

copyValues

public void copyValues(StructureMap dst)

typedCopy

protected StructureMap typedCopy()

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class MetadataResource

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class MetadataResource

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class MetadataResource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource

toString

public String toString()

Overrides:

toString in class MetadataResource