Package org.hl7.fhir.r5.terminologies

Class CodeSystemUtilities

java.lang.Object

org.hl7.fhir.r5.terminologies.TerminologyUtilities

org.hl7.fhir.r5.terminologies.CodeSystemUtilities

public class CodeSystemUtilities
extends TerminologyUtilities

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CodeSystemUtilities.CodeSystemNavigator
static class	CodeSystemUtilities.CodeSystemSorter
static class	CodeSystemUtilities.ConceptDefinitionComponentSorter
static enum	CodeSystemUtilities.ConceptStatus
static class	CodeSystemUtilities.SystemReference

Field Summary

Fields

Modifier and Type	Field	Description
static final String	USER_DATA_CROSS_LINK

Constructor Summary

Constructors

Constructor	Description
CodeSystemUtilities()

Method Summary

Modifier and Type	Method	Description
static void	addCSComments(CodeSystem cs, CodeSystem.ConceptDefinitionComponent cc, String comments)
static void	addOtherChild(CodeSystem cs, CodeSystem.ConceptDefinitionComponent owner, String code)
static boolean	checkDisplay(CodeSystem cs, CodeSystem.ConceptDefinitionComponent cd, String display)
static boolean	checkMakeShareable(CodeSystem cs)
static Set<String>	codes(CodeSystem cs)
static CodeSystem	convertSD(StructureDefinition sd)
static int	countCodes(CodeSystem cs)
static void	crossLinkCodeSystem(CodeSystem cs)
static void	defineChildProperty(CodeSystem cs)
static void	defineCodeSystemProperty(CodeSystem cs, String code, String description, CodeSystem.PropertyType type)
static void	defineNotSelectableProperty(CodeSystem cs)
static void	defineParentProperty(CodeSystem cs)
static void	defineStatusProperty(CodeSystem cs)
static CodeSystem.ConceptDefinitionComponent	findCode(List<CodeSystem.ConceptDefinitionComponent> list, String code)
static CodeSystem.ConceptDefinitionComponent	findCodeOrAltCode(List<CodeSystem.ConceptDefinitionComponent> list, String code, String use)
static List<CodeSystem.ConceptDefinitionComponent>	findCodeWithParents(List<CodeSystem.ConceptDefinitionComponent> parents, List<CodeSystem.ConceptDefinitionComponent> list, String code)
static CodeSystem.ConceptDefinitionComponent	getCode(CodeSystem cs, String code)
static String	getCodeDefinition(CodeSystem cs, String code)
static String	getCSComments(CodeSystem cs, CodeSystem.ConceptDefinitionComponent c)
static List<String>	getDisplays(CodeSystem srcCS, CodeSystem.ConceptDefinitionComponent cd)
static String	getOID(CanonicalResource cs)
static List<String>	getOtherChildren(CodeSystem cs, CodeSystem.ConceptDefinitionComponent c)
static CodeSystem.ConceptPropertyComponent	getProperty(CodeSystem.ConceptDefinitionComponent concept, String code)
static DataType	getProperty(CodeSystem cs, String code, String property)
static DataType	getProperty(CodeSystem cs, CodeSystem.ConceptDefinitionComponent def, String property)
static String	getProperty(CodeSystem cs, CodeSystem.ConceptDefinitionComponent c, String uri, String code)
static CodeSystem.PropertyComponent	getPropertyByUri(CodeSystem cs, String uri)
static CodeSystem.PropertyComponent	getPropertyDefinition(CodeSystem cs, String property)	property in this case is the name of a property that appears in a ValueSet filter
static List<CodeSystem.ConceptPropertyComponent>	getPropertyValues(CodeSystem.ConceptDefinitionComponent concept, String code)
static String	getStatus(CodeSystem cs, CodeSystem.ConceptDefinitionComponent cc)
static CodeSystemUtilities.SystemReference	getSystemReference(String system, IWorkerContext ctxt)
static boolean	hasCode(CodeSystem cs, String code)
static boolean	hasCSComments(CodeSystem cs, CodeSystem.ConceptDefinitionComponent c)
static boolean	hasDesignations(CodeSystem cs)
static boolean	hasHierarchy(CodeSystem cs)
static boolean	hasMarkdownInDefinitions(CodeSystem cs, org.hl7.fhir.utilities.MarkDownProcessor md)
static boolean	hasOID(CanonicalResource cs)
static boolean	hasProperties(CodeSystem cs)
static boolean	hasProperty(CodeSystem.ConceptDefinitionComponent c, String code)
static boolean	hasProperty(CodeSystem cs, CodeSystem.ConceptDefinitionComponent c, String uri, String code)
static boolean	hasPropertyDef(CodeSystem cs, String property)
static boolean	isDefinedProperty(CodeSystem cs, String property)
static boolean	isDeprecated(CodeSystem cs, CodeSystem.ConceptDefinitionComponent def, boolean ignoreStatus)
static boolean	isExemptFromMultipleVersionChecking(String url)
static boolean	isInactive(CodeSystem cs, String code)
static boolean	isInactive(CodeSystem cs, CodeSystem.ConceptDefinitionComponent def)
static boolean	isInactive(CodeSystem cs, CodeSystem.ConceptDefinitionComponent def, boolean ignoreStatus)
static boolean	isNotCurrent(CodeSystem cs, CodeSystem.ConceptDefinitionComponent c)
static boolean	isNotSelectable(CodeSystem cs, String code)
static boolean	isNotSelectable(CodeSystem cs, CodeSystem.ConceptDefinitionComponent def)
static CodeSystem	makeShareable(CodeSystem cs)
static void	markStatus(CodeSystem cs, String wg, org.hl7.fhir.utilities.StandardsStatus status, String pckage, String fmm, String normativeVersion)
static CodeSystem	mergeSupplements(CodeSystem cs, List<CodeSystem> supplements)
static Coding	readCoding(String jurisdiction)
static DataType	readProperty(CodeSystem.ConceptDefinitionComponent concept, String code)
static void	setDeprecated(CodeSystem cs, CodeSystem.ConceptDefinitionComponent concept)
static void	setDeprecated(CodeSystem cs, CodeSystem.ConceptDefinitionComponent concept, DateTimeType date)
static void	setNotSelectable(CodeSystem cs, CodeSystem.ConceptDefinitionComponent concept)
static void	setOID(CodeSystem cs, String oid)
static void	setProperty(CodeSystem cs, CodeSystem.ConceptDefinitionComponent concept, String url, String code, DataType value)
static void	setProperty(CodeSystem cs, CodeSystem.ConceptDefinitionComponent concept, String code, DataType value)
static void	setStatus(CodeSystem cs, CodeSystem.ConceptDefinitionComponent concept, CodeSystemUtilities.ConceptStatus status)
static void	sortAllCodes(CodeSystem cs)
static Boolean	subsumes(CodeSystem cs, String pc, String cc)

Methods inherited from class org.hl7.fhir.r5.terminologies.TerminologyUtilities

listOids, listSystems

Methods inherited from class java.lang.Object

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

Field Details

USER_DATA_CROSS_LINK

public static final String USER_DATA_CROSS_LINK

See Also:

• Constant Field Values

Constructor Details

CodeSystemUtilities

public CodeSystemUtilities()

Method Details

isNotSelectable

public static boolean isNotSelectable(@Nonnull
 CodeSystem cs,
 @Nonnull
 CodeSystem.ConceptDefinitionComponent def)

isNotSelectable

public static boolean isNotSelectable(@Nonnull
 CodeSystem cs,
 @Nonnull
 String code)

setNotSelectable

public static void setNotSelectable(@Nonnull
 CodeSystem cs,
 @Nonnull
 CodeSystem.ConceptDefinitionComponent concept)
                             throws org.hl7.fhir.exceptions.FHIRFormatError

Throws:

org.hl7.fhir.exceptions.FHIRFormatError

setProperty

public static void setProperty(@Nonnull
 CodeSystem cs,
 @Nonnull
 CodeSystem.ConceptDefinitionComponent concept,
 @Nonnull
 String code,
 @Nonnull
 DataType value)
                        throws org.hl7.fhir.exceptions.FHIRFormatError

Throws:

org.hl7.fhir.exceptions.FHIRFormatError

setProperty

public static void setProperty(@Nonnull
 CodeSystem cs,
 @Nonnull
 CodeSystem.ConceptDefinitionComponent concept,
 @Nonnull
 String url,
 @Nonnull
 String code,
 @Nonnull
 DataType value)
                        throws org.hl7.fhir.exceptions.FHIRFormatError

Throws:

org.hl7.fhir.exceptions.FHIRFormatError

defineNotSelectableProperty

public static void defineNotSelectableProperty(@Nonnull
 CodeSystem cs)

setStatus

public static void setStatus(@Nonnull
 CodeSystem cs,
 CodeSystem.ConceptDefinitionComponent concept,
 CodeSystemUtilities.ConceptStatus status)
                      throws org.hl7.fhir.exceptions.FHIRFormatError

Throws:

org.hl7.fhir.exceptions.FHIRFormatError

defineStatusProperty

public static void defineStatusProperty(@Nonnull
 CodeSystem cs)

defineParentProperty

public static void defineParentProperty(@Nonnull
 CodeSystem cs)

defineChildProperty

public static void defineChildProperty(@Nonnull
 CodeSystem cs)

isDeprecated

public static boolean isDeprecated(@Nonnull
 CodeSystem cs,
 @Nonnull
 CodeSystem.ConceptDefinitionComponent def,
 boolean ignoreStatus)

isInactive

public static boolean isInactive(@Nonnull
 CodeSystem cs,
 @Nonnull
 CodeSystem.ConceptDefinitionComponent def,
 boolean ignoreStatus)

setDeprecated

public static void setDeprecated(@Nonnull
 CodeSystem cs,
 @Nonnull
 CodeSystem.ConceptDefinitionComponent concept,
 @Nonnull
 DateTimeType date)
                          throws org.hl7.fhir.exceptions.FHIRFormatError

Throws:

org.hl7.fhir.exceptions.FHIRFormatError

setDeprecated

public static void setDeprecated(@Nonnull
 CodeSystem cs,
 @Nonnull
 CodeSystem.ConceptDefinitionComponent concept)
                          throws org.hl7.fhir.exceptions.FHIRFormatError

Throws:

org.hl7.fhir.exceptions.FHIRFormatError

isInactive

public static boolean isInactive(@Nonnull
 CodeSystem cs,
 @Nonnull
 CodeSystem.ConceptDefinitionComponent def)
                          throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

isInactive

public static boolean isInactive(@Nonnull
 CodeSystem cs,
 @Nonnull
 String code)
                          throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

defineCodeSystemProperty

public static void defineCodeSystemProperty(@Nonnull
 CodeSystem cs,
 @Nonnull
 String code,
 @Nonnull
 String description,
 @Nonnull
 CodeSystem.PropertyType type)

getCodeDefinition

public static String getCodeDefinition(@Nonnull
 CodeSystem cs,
 @Nonnull
 String code)

makeShareable

public static CodeSystem makeShareable(@Nonnull
 CodeSystem cs)

checkMakeShareable

public static boolean checkMakeShareable(@Nonnull
 CodeSystem cs)

setOID

public static void setOID(@Nonnull
 CodeSystem cs,
 @Nonnull
 String oid)

hasOID

public static boolean hasOID(@Nonnull
 CanonicalResource cs)

getOID

public static String getOID(@Nonnull
 CanonicalResource cs)

findCode

public static CodeSystem.ConceptDefinitionComponent findCode(@Nonnull
 List<CodeSystem.ConceptDefinitionComponent> list,
 @Nonnull
 String code)

findCodeWithParents

public static List<CodeSystem.ConceptDefinitionComponent> findCodeWithParents(@Nonnull
 List<CodeSystem.ConceptDefinitionComponent> parents,
 @Nonnull
 List<CodeSystem.ConceptDefinitionComponent> list,
 @Nonnull
 String code)

findCodeOrAltCode

public static CodeSystem.ConceptDefinitionComponent findCodeOrAltCode(@Nonnull
 List<CodeSystem.ConceptDefinitionComponent> list,
 @Nonnull
 String code,
 @Nonnull
 String use)

markStatus

public static void markStatus(@Nonnull
 CodeSystem cs,
 String wg,
 org.hl7.fhir.utilities.StandardsStatus status,
 String pckage,
 String fmm,
 String normativeVersion)
                       throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

readProperty

public static DataType readProperty(@Nonnull
 CodeSystem.ConceptDefinitionComponent concept,
 @Nonnull
 String code)

getProperty

public static CodeSystem.ConceptPropertyComponent getProperty(@Nonnull
 CodeSystem.ConceptDefinitionComponent concept,
 @Nonnull
 String code)

getPropertyValues

public static List<CodeSystem.ConceptPropertyComponent> getPropertyValues(@Nonnull
 CodeSystem.ConceptDefinitionComponent concept,
 @Nonnull
 String code)

getOtherChildren

public static List<String> getOtherChildren(@Nonnull
 CodeSystem cs,
 @Nonnull
 CodeSystem.ConceptDefinitionComponent c)

addOtherChild

public static void addOtherChild(@Nonnull
 CodeSystem cs,
 @Nonnull
 CodeSystem.ConceptDefinitionComponent owner,
 @Nonnull
 String code)

hasProperty

public static boolean hasProperty(@Nonnull
 CodeSystem.ConceptDefinitionComponent c,
 @Nonnull
 String code)

getProperty

public static String getProperty(@Nonnull
 CodeSystem cs,
 @Nonnull
 CodeSystem.ConceptDefinitionComponent c,
 @Nonnull
 String uri,
 @Nonnull
 String code)

hasProperty

public static boolean hasProperty(@Nonnull
 CodeSystem cs,
 @Nonnull
 CodeSystem.ConceptDefinitionComponent c,
 @Nonnull
 String uri,
 @Nonnull
 String code)

hasCode

public static boolean hasCode(@Nonnull
 CodeSystem cs,
 @Nonnull
 String code)

getCode

public static CodeSystem.ConceptDefinitionComponent getCode(@Nonnull
 CodeSystem cs,
 @Nonnull
 String code)

crossLinkCodeSystem

public static void crossLinkCodeSystem(@Nonnull
 CodeSystem cs)

hasHierarchy

public static boolean hasHierarchy(@Nonnull
 CodeSystem cs)

sortAllCodes

public static void sortAllCodes(@Nonnull
 CodeSystem cs)

readCoding

public static Coding readCoding(String jurisdiction)

getSystemReference

public static CodeSystemUtilities.SystemReference getSystemReference(String system,
 IWorkerContext ctxt)

isNotCurrent

public static boolean isNotCurrent(@Nonnull
 CodeSystem cs,
 @Nonnull
 CodeSystem.ConceptDefinitionComponent c)

getDisplays

public static List<String> getDisplays(@Nonnull
 CodeSystem srcCS,
 @Nonnull
 CodeSystem.ConceptDefinitionComponent cd)

checkDisplay

public static boolean checkDisplay(@Nonnull
 CodeSystem cs,
 @Nonnull
 CodeSystem.ConceptDefinitionComponent cd,
 @Nonnull
 String display)

countCodes

public static int countCodes(@Nonnull
 CodeSystem cs)

mergeSupplements

public static CodeSystem mergeSupplements(@Nonnull
 CodeSystem cs,
 @Nonnull
 List<CodeSystem> supplements)

hasProperties

public static boolean hasProperties(@Nonnull
 CodeSystem cs)

hasDesignations

public static boolean hasDesignations(@Nonnull
 CodeSystem cs)

hasPropertyDef

public static boolean hasPropertyDef(@Nonnull
 CodeSystem cs,
 @Nonnull
 String property)

getProperty

public static DataType getProperty(@Nonnull
 CodeSystem cs,
 @Nonnull
 String code,
 @Nonnull
 String property)

getProperty

public static DataType getProperty(@Nonnull
 CodeSystem cs,
 @Nonnull
 CodeSystem.ConceptDefinitionComponent def,
 @Nonnull
 String property)

hasMarkdownInDefinitions

public static boolean hasMarkdownInDefinitions(@Nonnull
 CodeSystem cs,
 @Nonnull
 org.hl7.fhir.utilities.MarkDownProcessor md)

getStatus

public static String getStatus(@Nonnull
 CodeSystem cs,
 @Nonnull
 CodeSystem.ConceptDefinitionComponent cc)

subsumes

public static Boolean subsumes(@Nonnull
 CodeSystem cs,
 @Nonnull
 String pc,
 @Nonnull
 String cc)

codes

public static Set<String> codes(@Nonnull
 CodeSystem cs)

getPropertyDefinition

public static CodeSystem.PropertyComponent getPropertyDefinition(@Nonnull
 CodeSystem cs,
 @Nonnull
 String property)

property in this case is the name of a property that appears in a ValueSet filter

Parameters:

cs -

property -

Returns:

isDefinedProperty

public static boolean isDefinedProperty(@Nonnull
 CodeSystem cs,
 @Nonnull
 String property)

isExemptFromMultipleVersionChecking

public static boolean isExemptFromMultipleVersionChecking(String url)

getPropertyByUri

public static CodeSystem.PropertyComponent getPropertyByUri(@Nonnull
 CodeSystem cs,
 @Nonnull
 String uri)

convertSD

public static CodeSystem convertSD(@Nonnull
 StructureDefinition sd)

hasCSComments

public static boolean hasCSComments(@Nonnull
 CodeSystem cs,
 @Nonnull
 CodeSystem.ConceptDefinitionComponent c)

getCSComments

public static String getCSComments(@Nonnull
 CodeSystem cs,
 @Nonnull
 CodeSystem.ConceptDefinitionComponent c)

addCSComments

public static void addCSComments(@Nonnull
 CodeSystem cs,
 @Nonnull
 CodeSystem.ConceptDefinitionComponent cc,
 @Nonnull
 String comments)