Package org.hl7.fhir.r5.utils.structuremap

Class StructureMapUtilities

java.lang.Object

org.hl7.fhir.r5.utils.structuremap.StructureMapUtilities

public class StructureMapUtilities
extends Object

Services in this class:

string render(map) - take a structure and convert it to text map parse(text) - take a text representation and parse it getTargetType(map) - return the definition for the type to create to hand in transform(appInfo, source, map, target) - transform from source to target following the map analyse(appInfo, map) - generate profiles and other analysis artifacts for the targets of the transform map generateMapFromMappings(StructureDefinition) - build a mapping from a structure definition with loigcal mappings

Author:

Grahame Grieve

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTO_VAR_NAME
static final String	DEF_GROUP_NAME
static final String	MAP_EXPRESSION
static final String	MAP_SEARCH_EXPRESSION
static final String	MAP_WHERE_CHECK
static final String	MAP_WHERE_EXPRESSION
static final String	MAP_WHERE_LOG

Constructor Summary

Constructors

Constructor	Description
StructureMapUtilities(IWorkerContext worker)
StructureMapUtilities(IWorkerContext worker, ITransformerServices services)
StructureMapUtilities(IWorkerContext worker, ITransformerServices services, ProfileKnowledgeProvider pkp)

Method Summary

Modifier and Type	Method	Description
StructureMapAnalysis	analyse(Object appInfo, StructureMap map)	Given a structure map, return a set of analyses on it.
StructureMap	generateMapFromMappings(StructureDefinition sd)
protected void	getChildrenByName(Base item, String name, List<Base> result)	Given an item, return all the children that conform to the pattern described in name
ResolvedGroup	getGroupForUrl(StructureMap map, String url, StructureMap.StructureMapInputMode mode)
String	getInputType(ResolvedGroup grp, StructureMap.StructureMapInputMode mode)
List<StructureMap>	getMapsForUrl(List<StructureMap> maps, String url, StructureMap.StructureMapInputMode mode)
List<StructureMap>	getMapsForUrlPrefix(List<StructureMap> maps, String url, StructureMap.StructureMapInputMode mode)
ITransformerServices	getServices()
StructureDefinition	getTargetType(StructureMap map)
org.hl7.fhir.utilities.validation.ValidationOptions	getTerminologyServiceOptions()
IWorkerContext	getWorker()
static String	groupToString(StructureMap.StructureMapGroupComponent g)
boolean	isDebug()
boolean	isExceptionsForChecks()
static String	paramToString(StructureMap.StructureMapGroupRuleTargetParameterComponent rtp)
StructureMap	parse(String text, String srcName)
static String	render(StructureMap map)
static String	ruleToString(StructureMap.StructureMapGroupRuleComponent r)
void	setDebug(boolean debug)
void	setExceptionsForChecks(boolean exceptionsForChecks)
void	setTerminologyServiceOptions(org.hl7.fhir.utilities.validation.ValidationOptions terminologyServiceOptions)
static String	sourceToString(StructureMap.StructureMapGroupRuleSourceComponent r)
static String	targetToString(StructureMap.StructureMapGroupRuleTargetComponent rt)
void	transform(Object appInfo, Base source, StructureMap map, Base target)
Base	translate(TransformContext context, StructureMap map, Base source, String conceptMapUrl, String fieldToReturn)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

MAP_WHERE_CHECK

public static final String MAP_WHERE_CHECK

See Also:

• Constant Field Values

MAP_WHERE_LOG

public static final String MAP_WHERE_LOG

See Also:

• Constant Field Values

MAP_WHERE_EXPRESSION

public static final String MAP_WHERE_EXPRESSION

See Also:

• Constant Field Values

MAP_SEARCH_EXPRESSION

public static final String MAP_SEARCH_EXPRESSION

See Also:

• Constant Field Values

MAP_EXPRESSION

public static final String MAP_EXPRESSION

See Also:

• Constant Field Values

AUTO_VAR_NAME

public static final String AUTO_VAR_NAME

See Also:

• Constant Field Values

DEF_GROUP_NAME

public static final String DEF_GROUP_NAME

See Also:

• Constant Field Values

Constructor Details

StructureMapUtilities

public StructureMapUtilities(IWorkerContext worker,
 ITransformerServices services,
 ProfileKnowledgeProvider pkp)

StructureMapUtilities

public StructureMapUtilities(IWorkerContext worker,
 ITransformerServices services)

StructureMapUtilities

public StructureMapUtilities(IWorkerContext worker)

Method Details

render

public static String render(StructureMap map)

groupToString

public static String groupToString(StructureMap.StructureMapGroupComponent g)

ruleToString

public static String ruleToString(StructureMap.StructureMapGroupRuleComponent r)

sourceToString

public static String sourceToString(StructureMap.StructureMapGroupRuleSourceComponent r)

targetToString

public static String targetToString(StructureMap.StructureMapGroupRuleTargetComponent rt)

paramToString

public static String paramToString(StructureMap.StructureMapGroupRuleTargetParameterComponent rtp)

getServices

public ITransformerServices getServices()

getWorker

public IWorkerContext getWorker()

parse

public StructureMap parse(String text,
 String srcName)
                   throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

getTargetType

public StructureDefinition getTargetType(StructureMap map)
                                  throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

getChildrenByName

protected void getChildrenByName(Base item,
 String name,
 List<Base> result)
                          throws org.hl7.fhir.exceptions.FHIRException

Given an item, return all the children that conform to the pattern described in name

Possible patterns: - a simple name (which may be the base of a name with [] e.g. value[x]) - a name with a type replacement e.g. valueCodeableConcept - * which means all children - ** which means all descendents

Parameters:

item -

name -

result -

Throws:

org.hl7.fhir.exceptions.FHIRException

transform

public void transform(Object appInfo,
 Base source,
 StructureMap map,
 Base target)
               throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

translate

public Base translate(TransformContext context,
 StructureMap map,
 Base source,
 String conceptMapUrl,
 String fieldToReturn)
               throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

analyse

public StructureMapAnalysis analyse(Object appInfo,
 StructureMap map)
                             throws org.hl7.fhir.exceptions.FHIRException

Given a structure map, return a set of analyses on it.

Returned: - a list or profiles for what it will create. First profile is the target - a table with a summary (in xhtml) for easy human undertanding of the mapping

Parameters:

appInfo -

map -

Returns:

Throws:

Exception

org.hl7.fhir.exceptions.FHIRException

generateMapFromMappings

public StructureMap generateMapFromMappings(StructureDefinition sd)
                                     throws IOException,
org.hl7.fhir.exceptions.FHIRException

Throws:

IOException

org.hl7.fhir.exceptions.FHIRException

getTerminologyServiceOptions

public org.hl7.fhir.utilities.validation.ValidationOptions getTerminologyServiceOptions()

setTerminologyServiceOptions

public void setTerminologyServiceOptions(org.hl7.fhir.utilities.validation.ValidationOptions terminologyServiceOptions)

isExceptionsForChecks

public boolean isExceptionsForChecks()

setExceptionsForChecks

public void setExceptionsForChecks(boolean exceptionsForChecks)

getMapsForUrl

public List<StructureMap> getMapsForUrl(List<StructureMap> maps,
 String url,
 StructureMap.StructureMapInputMode mode)

getMapsForUrlPrefix

public List<StructureMap> getMapsForUrlPrefix(List<StructureMap> maps,
 String url,
 StructureMap.StructureMapInputMode mode)

getGroupForUrl

public ResolvedGroup getGroupForUrl(StructureMap map,
 String url,
 StructureMap.StructureMapInputMode mode)

getInputType

public String getInputType(ResolvedGroup grp,
 StructureMap.StructureMapInputMode mode)

isDebug

public boolean isDebug()

setDebug

public void setDebug(boolean debug)