Package org.hl7.fhir.dstu3.model

Class ConceptMap

java.lang.Object

org.hl7.fhir.dstu3.model.Base

org.hl7.fhir.dstu3.model.BaseResource

org.hl7.fhir.dstu3.model.Resource

org.hl7.fhir.dstu3.model.DomainResource

org.hl7.fhir.dstu3.model.MetadataResource

org.hl7.fhir.dstu3.model.ConceptMap

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 ConceptMap
extends MetadataResource

A statement of relationships from one set of concepts to one or more other concepts - either code systems or data elements, or classes in class models.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ConceptMap.ConceptMapGroupComponent
static class	ConceptMap.ConceptMapGroupUnmappedComponent
static class	ConceptMap.ConceptMapGroupUnmappedMode
static class	ConceptMap.ConceptMapGroupUnmappedModeEnumFactory
static class	ConceptMap.OtherElementComponent
static class	ConceptMap.SourceElementComponent
static class	ConceptMap.TargetElementComponent

Field Summary

Fields

Modifier and Type	Field	Description
protected MarkdownType	copyright	A copyright statement relating to the concept map and/or its contents.
static ca.uhn.fhir.rest.gclient.DateClientParam	DATE	Fluent Client search parameter constant for date
static ca.uhn.fhir.rest.gclient.UriClientParam	DEPENDSON	Fluent Client search parameter constant for dependson
static ca.uhn.fhir.rest.gclient.StringClientParam	DESCRIPTION	Fluent Client search parameter constant for description
protected List<ConceptMap.ConceptMapGroupComponent>	group	A group of mappings that all have the same source and target system.
protected Identifier	identifier	A formal identifier that is used to identify this concept map when it is represented in other formats, or referenced in a specification, model, design or an instance.
static ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
static ca.uhn.fhir.model.api.Include	INCLUDE_SOURCE	Constant for fluent queries to be used to add include statements.
static ca.uhn.fhir.model.api.Include	INCLUDE_SOURCE_URI	Constant for fluent queries to be used to add include statements.
static ca.uhn.fhir.model.api.Include	INCLUDE_TARGET	Constant for fluent queries to be used to add include statements.
static ca.uhn.fhir.model.api.Include	INCLUDE_TARGET_URI	Constant for fluent queries to be used to add include statements.
static ca.uhn.fhir.rest.gclient.TokenClientParam	JURISDICTION	Fluent Client search parameter constant for jurisdiction
static ca.uhn.fhir.rest.gclient.StringClientParam	NAME	Fluent Client search parameter constant for name
static ca.uhn.fhir.rest.gclient.UriClientParam	OTHER	Fluent Client search parameter constant for other
static ca.uhn.fhir.rest.gclient.UriClientParam	PRODUCT	Fluent Client search parameter constant for product
static ca.uhn.fhir.rest.gclient.StringClientParam	PUBLISHER	Fluent Client search parameter constant for publisher
protected MarkdownType	purpose	Explaination of why this concept map is needed and why it has been designed as it has.
protected Type	source	The source value set that specifies the concepts that are being mapped.
static ca.uhn.fhir.rest.gclient.ReferenceClientParam	SOURCE	Fluent Client search parameter constant for source
static ca.uhn.fhir.rest.gclient.TokenClientParam	SOURCE_CODE	Fluent Client search parameter constant for source-code
static ca.uhn.fhir.rest.gclient.UriClientParam	SOURCE_SYSTEM	Fluent Client search parameter constant for source-system
static ca.uhn.fhir.rest.gclient.ReferenceClientParam	SOURCE_URI	Fluent Client search parameter constant for source-uri
static String	SP_DATE	Search parameter: date
static String	SP_DEPENDSON	Search parameter: dependson
static String	SP_DESCRIPTION	Search parameter: description
static String	SP_IDENTIFIER	Search parameter: identifier
static String	SP_JURISDICTION	Search parameter: jurisdiction
static String	SP_NAME	Search parameter: name
static String	SP_OTHER	Search parameter: other
static String	SP_PRODUCT	Search parameter: product
static String	SP_PUBLISHER	Search parameter: publisher
static String	SP_SOURCE	Search parameter: source
static String	SP_SOURCE_CODE	Search parameter: source-code
static String	SP_SOURCE_SYSTEM	Search parameter: source-system
static String	SP_SOURCE_URI	Search parameter: source-uri
static String	SP_STATUS	Search parameter: status
static String	SP_TARGET	Search parameter: target
static String	SP_TARGET_CODE	Search parameter: target-code
static String	SP_TARGET_SYSTEM	Search parameter: target-system
static String	SP_TARGET_URI	Search parameter: target-uri
static String	SP_TITLE	Search parameter: title
static String	SP_URL	Search parameter: url
static String	SP_VERSION	Search parameter: version
static ca.uhn.fhir.rest.gclient.TokenClientParam	STATUS	Fluent Client search parameter constant for status
protected Type	target	The target value set provides context to the mappings.
static ca.uhn.fhir.rest.gclient.ReferenceClientParam	TARGET	Fluent Client search parameter constant for target
static ca.uhn.fhir.rest.gclient.TokenClientParam	TARGET_CODE	Fluent Client search parameter constant for target-code
static ca.uhn.fhir.rest.gclient.UriClientParam	TARGET_SYSTEM	Fluent Client search parameter constant for target-system
static ca.uhn.fhir.rest.gclient.ReferenceClientParam	TARGET_URI	Fluent Client search parameter constant for target-uri
static ca.uhn.fhir.rest.gclient.StringClientParam	TITLE	Fluent Client search parameter constant for title
static ca.uhn.fhir.rest.gclient.UriClientParam	URL	Fluent Client search parameter constant for url
static ca.uhn.fhir.rest.gclient.TokenClientParam	VERSION	Fluent Client search parameter constant for version

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

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

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

contained, extension, modifierExtension, text

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

id, implicitRules, language, meta

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

RES_ID, SP_RES_ID, SP_RES_LANGUAGE

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

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
ConceptMap()	Constructor
ConceptMap(Enumeration<Enumerations.PublicationStatus> status)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
ContactDetail	addContact()
ConceptMap	addContact(ContactDetail t)
ConceptMap.ConceptMapGroupComponent	addGroup()
ConceptMap	addGroup(ConceptMap.ConceptMapGroupComponent t)
CodeableConcept	addJurisdiction()
ConceptMap	addJurisdiction(CodeableConcept t)
UsageContext	addUseContext()
ConceptMap	addUseContext(UsageContext t)
ConceptMap	copy()
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<ConceptMap.ConceptMapGroupComponent>	getGroup()
ConceptMap.ConceptMapGroupComponent	getGroupFirstRep()
Identifier	getIdentifier()
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()
Type	getSource()
Reference	getSourceReference()
UriType	getSourceUriType()
Enumerations.PublicationStatus	getStatus()
Enumeration<Enumerations.PublicationStatus>	getStatusElement()
Type	getTarget()
Reference	getTargetReference()
UriType	getTargetUriType()
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	hasJurisdiction()
boolean	hasName()
boolean	hasNameElement()
boolean	hasPublisher()
boolean	hasPublisherElement()
boolean	hasPurpose()
boolean	hasPurposeElement()
boolean	hasSource()
boolean	hasSourceReference()
boolean	hasSourceUriType()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasTarget()
boolean	hasTargetReference()
boolean	hasTargetUriType()
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)
ConceptMap	setContact(List<ContactDetail> theContact)
ConceptMap	setCopyright(String value)
ConceptMap	setCopyrightElement(MarkdownType value)
ConceptMap	setDate(Date value)
ConceptMap	setDateElement(DateTimeType value)
ConceptMap	setDescription(String value)
ConceptMap	setDescriptionElement(MarkdownType value)
ConceptMap	setExperimental(boolean value)
ConceptMap	setExperimentalElement(BooleanType value)
ConceptMap	setGroup(List<ConceptMap.ConceptMapGroupComponent> theGroup)
ConceptMap	setIdentifier(Identifier value)
ConceptMap	setJurisdiction(List<CodeableConcept> theJurisdiction)
ConceptMap	setName(String value)
ConceptMap	setNameElement(StringType value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
ConceptMap	setPublisher(String value)
ConceptMap	setPublisherElement(StringType value)
ConceptMap	setPurpose(String value)
ConceptMap	setPurposeElement(MarkdownType value)
ConceptMap	setSource(Type value)
ConceptMap	setStatus(Enumerations.PublicationStatus value)
ConceptMap	setStatusElement(Enumeration<Enumerations.PublicationStatus> value)
ConceptMap	setTarget(Type value)
ConceptMap	setTitle(String value)
ConceptMap	setTitleElement(StringType value)
ConceptMap	setUrl(String value)
ConceptMap	setUrlElement(UriType value)
ConceptMap	setUseContext(List<UsageContext> theUseContext)
ConceptMap	setVersion(String value)
ConceptMap	setVersionElement(StringType value)
protected ConceptMap	typedCopy()

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

checkCanUseUrl, copyValues, toString

Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource

addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

Methods inherited from class org.hl7.fhir.dstu3.model.Resource

copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, 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.dstu3.model.BaseResource

getStructureFhirVersionEnum, isResource, setId

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

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, 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

identifier

protected Identifier identifier

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

purpose

protected MarkdownType purpose

Explaination of why this concept map is needed and why it has been designed as it has.

copyright

protected MarkdownType copyright

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

source

protected Type source

The source value set that specifies the concepts that are being mapped.

target

protected Type target

The target value set provides context to the mappings. Note that the mapping is made between concepts, not between value sets, but the value set provides important context about how the concept mapping choices are made.

group

protected List<ConceptMap.ConceptMapGroupComponent> group

A group of mappings that all have the same source and target system.

SP_DATE

public static final String SP_DATE

Search parameter: date

Description: The concept map publication date
Type: date
Path: ConceptMap.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 concept map publication date
Type: date
Path: ConceptMap.date

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: External identifier for the concept map
Type: token
Path: ConceptMap.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 concept map
Type: token
Path: ConceptMap.identifier

SP_PRODUCT

public static final String SP_PRODUCT

Search parameter: product

Description: Reference to property mapping depends on
Type: uri
Path: ConceptMap.group.element.target.product.property

See Also:

Constant Field Values

PRODUCT

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

Fluent Client search parameter constant for product

Description: Reference to property mapping depends on
Type: uri
Path: ConceptMap.group.element.target.product.property

SP_OTHER

public static final String SP_OTHER

Search parameter: other

Description: Canonical URL for other concept map
Type: uri
Path: ConceptMap.group.unmapped.url

See Also:

Constant Field Values

OTHER

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

Fluent Client search parameter constant for other

Description: Canonical URL for other concept map
Type: uri
Path: ConceptMap.group.unmapped.url

SP_TARGET_SYSTEM

public static final String SP_TARGET_SYSTEM

Search parameter: target-system

Description: System of the target (if necessary)
Type: uri
Path: ConceptMap.group.target

See Also:

Constant Field Values

TARGET_SYSTEM

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

Fluent Client search parameter constant for target-system

Description: System of the target (if necessary)
Type: uri
Path: ConceptMap.group.target

SP_DEPENDSON

public static final String SP_DEPENDSON

Search parameter: dependson

Description: Reference to property mapping depends on
Type: uri
Path: ConceptMap.group.element.target.dependsOn.property

See Also:

Constant Field Values

DEPENDSON

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

Fluent Client search parameter constant for dependson

Description: Reference to property mapping depends on
Type: uri
Path: ConceptMap.group.element.target.dependsOn.property

SP_JURISDICTION

public static final String SP_JURISDICTION

Search parameter: jurisdiction

Description: Intended jurisdiction for the concept map
Type: token
Path: ConceptMap.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 concept map
Type: token
Path: ConceptMap.jurisdiction

SP_DESCRIPTION

public static final String SP_DESCRIPTION

Search parameter: description

Description: The description of the concept map
Type: string
Path: ConceptMap.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 concept map
Type: string
Path: ConceptMap.description

SP_SOURCE

public static final String SP_SOURCE

Search parameter: source

Description: Identifies the source of the concepts which are being mapped
Type: reference
Path: ConceptMap.sourceReference

See Also:

Constant Field Values

SOURCE

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SOURCE

Fluent Client search parameter constant for source

Description: Identifies the source of the concepts which are being mapped
Type: reference
Path: ConceptMap.sourceReference

INCLUDE_SOURCE

public static final ca.uhn.fhir.model.api.Include INCLUDE_SOURCE

Constant for fluent queries to be used to add include statements. Specifies the path value of "ConceptMap:source".

SP_TITLE

public static final String SP_TITLE

Search parameter: title

Description: The human-friendly name of the concept map
Type: string
Path: ConceptMap.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 concept map
Type: string
Path: ConceptMap.title

SP_VERSION

public static final String SP_VERSION

Search parameter: version

Description: The business version of the concept map
Type: token
Path: ConceptMap.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 concept map
Type: token
Path: ConceptMap.version

SP_URL

public static final String SP_URL

Search parameter: url

Description: The uri that identifies the concept map
Type: uri
Path: ConceptMap.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 concept map
Type: uri
Path: ConceptMap.url

SP_TARGET

public static final String SP_TARGET

Search parameter: target

Description: Provides context to the mappings
Type: reference
Path: ConceptMap.targetReference

See Also:

Constant Field Values

TARGET

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam TARGET

Fluent Client search parameter constant for target

Description: Provides context to the mappings
Type: reference
Path: ConceptMap.targetReference

INCLUDE_TARGET

public static final ca.uhn.fhir.model.api.Include INCLUDE_TARGET

Constant for fluent queries to be used to add include statements. Specifies the path value of "ConceptMap:target".

SP_SOURCE_CODE

public static final String SP_SOURCE_CODE

Search parameter: source-code

Description: Identifies element being mapped
Type: token
Path: ConceptMap.group.element.code

See Also:

Constant Field Values

SOURCE_CODE

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

Fluent Client search parameter constant for source-code

Description: Identifies element being mapped
Type: token
Path: ConceptMap.group.element.code

SP_SOURCE_URI

public static final String SP_SOURCE_URI

Search parameter: source-uri

Description: Identifies the source of the concepts which are being mapped
Type: reference
Path: ConceptMap.sourceUri

See Also:

Constant Field Values

SOURCE_URI

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SOURCE_URI

Fluent Client search parameter constant for source-uri

Description: Identifies the source of the concepts which are being mapped
Type: reference
Path: ConceptMap.sourceUri

INCLUDE_SOURCE_URI

public static final ca.uhn.fhir.model.api.Include INCLUDE_SOURCE_URI

Constant for fluent queries to be used to add include statements. Specifies the path value of "ConceptMap:source-uri".

SP_NAME

public static final String SP_NAME

Search parameter: name

Description: Computationally friendly name of the concept map
Type: string
Path: ConceptMap.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 concept map
Type: string
Path: ConceptMap.name

SP_PUBLISHER

public static final String SP_PUBLISHER

Search parameter: publisher

Description: Name of the publisher of the concept map
Type: string
Path: ConceptMap.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 concept map
Type: string
Path: ConceptMap.publisher

SP_SOURCE_SYSTEM

public static final String SP_SOURCE_SYSTEM

Search parameter: source-system

Description: Code System (if value set crosses code systems)
Type: uri
Path: ConceptMap.group.source

See Also:

Constant Field Values

SOURCE_SYSTEM

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

Fluent Client search parameter constant for source-system

Description: Code System (if value set crosses code systems)
Type: uri
Path: ConceptMap.group.source

SP_TARGET_CODE

public static final String SP_TARGET_CODE

Search parameter: target-code

Description: Code that identifies the target element
Type: token
Path: ConceptMap.group.element.target.code

See Also:

Constant Field Values

TARGET_CODE

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

Fluent Client search parameter constant for target-code

Description: Code that identifies the target element
Type: token
Path: ConceptMap.group.element.target.code

SP_STATUS

public static final String SP_STATUS

Search parameter: status

Description: The current status of the concept map
Type: token
Path: ConceptMap.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 concept map
Type: token
Path: ConceptMap.status

SP_TARGET_URI

public static final String SP_TARGET_URI

Search parameter: target-uri

Description: Provides context to the mappings
Type: reference
Path: ConceptMap.targetUri

See Also:

Constant Field Values

TARGET_URI

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam TARGET_URI

Fluent Client search parameter constant for target-uri

Description: Provides context to the mappings
Type: reference
Path: ConceptMap.targetUri

INCLUDE_TARGET_URI

public static final ca.uhn.fhir.model.api.Include INCLUDE_TARGET_URI

Constant for fluent queries to be used to add include statements. Specifies the path value of "ConceptMap:target-uri".

Constructor Details

ConceptMap

public ConceptMap()

Constructor

ConceptMap

public ConceptMap(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 concept map when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this concept map is (or will be) published. The URL SHOULD include the major version of the concept map. For more information see [Technical and Business Versions](resource.html#versions).). 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 ConceptMap setUrlElement(UriType value)

Overrides:

setUrlElement in class MetadataResource

Parameters:

value - MetadataResource.url (An absolute URI that is used to identify this concept map when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this concept map is (or will be) published. The URL SHOULD include the major version of the concept map. For more information see [Technical and Business Versions](resource.html#versions).). 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 concept map when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this concept map is (or will be) published. The URL SHOULD include the major version of the concept map. For more information see [Technical and Business Versions](resource.html#versions).

setUrl

public ConceptMap setUrl(String value)

Overrides:

setUrl in class MetadataResource

Parameters:

value - An absolute URI that is used to identify this concept map when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this concept map is (or will be) published. The URL SHOULD include the major version of the concept map. For more information see [Technical and Business Versions](resource.html#versions).

getIdentifier

public Identifier getIdentifier()

Returns:

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

hasIdentifier

public boolean hasIdentifier()

setIdentifier

public ConceptMap setIdentifier(Identifier value)

Parameters:

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

getVersionElement

public StringType getVersionElement()

Overrides:

getVersionElement in class MetadataResource

Returns:

MetadataResource.version (The identifier that is used to identify this version of the concept map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the concept 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 ConceptMap setVersionElement(StringType value)

Overrides:

setVersionElement in class MetadataResource

Parameters:

value - MetadataResource.version (The identifier that is used to identify this version of the concept map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the concept 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 concept map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the concept 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 ConceptMap setVersion(String value)

Overrides:

setVersion in class MetadataResource

Parameters:

value - The identifier that is used to identify this version of the concept map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the concept 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 concept 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 ConceptMap setNameElement(StringType value)

Overrides:

setNameElement in class MetadataResource

Parameters:

value - MetadataResource.name (A natural language name identifying the concept 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 concept map. This name should be usable as an identifier for the module by machine processing applications such as code generation.

setName

public ConceptMap setName(String value)

Overrides:

setName in class MetadataResource

Parameters:

value - A natural language name identifying the concept 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 concept 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 ConceptMap setTitleElement(StringType value)

Overrides:

setTitleElement in class MetadataResource

Parameters:

value - MetadataResource.title (A short, descriptive, user-friendly title for the concept 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 concept map.

setTitle

public ConceptMap setTitle(String value)

Overrides:

setTitle in class MetadataResource

Parameters:

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

getStatusElement

public Enumeration<Enumerations.PublicationStatus> getStatusElement()

Overrides:

getStatusElement in class MetadataResource

Returns:

MetadataResource.status (The status of this concept 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 ConceptMap setStatusElement(Enumeration<Enumerations.PublicationStatus> value)

Overrides:

setStatusElement in class MetadataResource

Parameters:

value - MetadataResource.status (The status of this concept 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 concept map. Enables tracking the life-cycle of the content.

setStatus

public ConceptMap setStatus(Enumerations.PublicationStatus value)

Overrides:

setStatus in class MetadataResource

Parameters:

value - The status of this concept 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 concept 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 ConceptMap setExperimentalElement(BooleanType value)

Overrides:

setExperimentalElement in class MetadataResource

Parameters:

value - MetadataResource.experimental (A boolean value to indicate that this concept 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 concept map is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.

setExperimental

public ConceptMap setExperimental(boolean value)

Overrides:

setExperimental in class MetadataResource

Parameters:

value - A boolean value to indicate that this concept 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 concept map was published. The date must change if and 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 concept 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 ConceptMap setDateElement(DateTimeType value)

Overrides:

setDateElement in class MetadataResource

Parameters:

value - MetadataResource.date (The date (and optionally time) when the concept map was published. The date must change if and 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 concept 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 concept map was published. The date must change if and 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 concept map changes.

setDate

public ConceptMap setDate(Date value)

Overrides:

setDate in class MetadataResource

Parameters:

value - The date (and optionally time) when the concept map was published. The date must change if and 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 concept map changes.

getPublisherElement

public StringType getPublisherElement()

Overrides:

getPublisherElement in class MetadataResource

Returns:

MetadataResource.publisher (The name of the individual or organization that published the concept 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 ConceptMap setPublisherElement(StringType value)

Overrides:

setPublisherElement in class MetadataResource

Parameters:

value - MetadataResource.publisher (The name of the individual or organization that published the concept 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 individual or organization that published the concept map.

setPublisher

public ConceptMap setPublisher(String value)

Overrides:

setPublisher in class MetadataResource

Parameters:

value - The name of the individual or organization that published the concept 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 ConceptMap 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 ConceptMap 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 concept 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 ConceptMap setDescriptionElement(MarkdownType value)

Overrides:

setDescriptionElement in class MetadataResource

Parameters:

value - MetadataResource.description (A free text natural language description of the concept 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 concept map from a consumer's perspective.

setDescription

public ConceptMap setDescription(String value)

Overrides:

setDescription in class MetadataResource

Parameters:

value - A free text natural language description of the concept 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 terms may be used to assist with indexing and searching for appropriate concept map instances.)

setUseContext

public ConceptMap 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 ConceptMap 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 concept map is intended to be used.)

setJurisdiction

public ConceptMap 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 ConceptMap 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 (Explaination of why this concept 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 ConceptMap setPurposeElement(MarkdownType value)

Parameters:

value - purpose (Explaination of why this concept 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:

Explaination of why this concept map is needed and why it has been designed as it has.

setPurpose

public ConceptMap setPurpose(String value)

Parameters:

value - Explaination of why this concept map is needed and why it has been designed as it has.

getCopyrightElement

public MarkdownType getCopyrightElement()

Returns:

copyright (A copyright statement relating to the concept map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the concept 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 ConceptMap setCopyrightElement(MarkdownType value)

Parameters:

value - copyright (A copyright statement relating to the concept map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the concept 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 concept map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the concept map.

setCopyright

public ConceptMap setCopyright(String value)

Parameters:

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

getSource

public Type getSource()

Returns:

source (The source value set that specifies the concepts that are being mapped.)

getSourceUriType

public UriType getSourceUriType()
                         throws org.hl7.fhir.exceptions.FHIRException

Returns:

source (The source value set that specifies the concepts that are being mapped.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasSourceUriType

public boolean hasSourceUriType()

getSourceReference

public Reference getSourceReference()
                             throws org.hl7.fhir.exceptions.FHIRException

Returns:

source (The source value set that specifies the concepts that are being mapped.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasSourceReference

public boolean hasSourceReference()

hasSource

public boolean hasSource()

setSource

public ConceptMap setSource(Type value)
                     throws org.hl7.fhir.exceptions.FHIRFormatError

Parameters:

value - source (The source value set that specifies the concepts that are being mapped.)

Throws:

org.hl7.fhir.exceptions.FHIRFormatError

getTarget

public Type getTarget()

Returns:

target (The target value set provides context to the mappings. Note that the mapping is made between concepts, not between value sets, but the value set provides important context about how the concept mapping choices are made.)

getTargetUriType

public UriType getTargetUriType()
                         throws org.hl7.fhir.exceptions.FHIRException

Returns:

target (The target value set provides context to the mappings. Note that the mapping is made between concepts, not between value sets, but the value set provides important context about how the concept mapping choices are made.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasTargetUriType

public boolean hasTargetUriType()

getTargetReference

public Reference getTargetReference()
                             throws org.hl7.fhir.exceptions.FHIRException

Returns:

target (The target value set provides context to the mappings. Note that the mapping is made between concepts, not between value sets, but the value set provides important context about how the concept mapping choices are made.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasTargetReference

public boolean hasTargetReference()

hasTarget

public boolean hasTarget()

setTarget

public ConceptMap setTarget(Type value)
                     throws org.hl7.fhir.exceptions.FHIRFormatError

Parameters:

value - target (The target value set provides context to the mappings. Note that the mapping is made between concepts, not between value sets, but the value set provides important context about how the concept mapping choices are made.)

Throws:

org.hl7.fhir.exceptions.FHIRFormatError

getGroup

public List<ConceptMap.ConceptMapGroupComponent> getGroup()

Returns:

group (A group of mappings that all have the same source and target system.)

setGroup

public ConceptMap setGroup(List<ConceptMap.ConceptMapGroupComponent> theGroup)

Returns:

Returns a reference to this for easy method chaining

hasGroup

public boolean hasGroup()

addGroup

public ConceptMap.ConceptMapGroupComponent addGroup()

addGroup

public ConceptMap addGroup(ConceptMap.ConceptMapGroupComponent t)

getGroupFirstRep

public ConceptMap.ConceptMapGroupComponent 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 MetadataResource

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

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 ConceptMap copy()

Specified by:

copy in class MetadataResource

typedCopy

protected ConceptMap 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