Class ConceptMap

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource

    public class ConceptMap
    extends BaseResource
    implements ca.uhn.fhir.model.api.IResource
    HAPI/FHIR ConceptMap Resource ()

    Definition: 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

    Requirements:

    Profile Definition: http://hl7.org/fhir/profiles/ConceptMap

    See Also:
    Serialized Form
    • Field Detail

      • SP_URL

        public static final String SP_URL
        Search parameter constant for url

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

      • SP_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter constant for identifier

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

      • SP_VERSION

        public static final String SP_VERSION
        Search parameter constant for version

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

      • SP_NAME

        public static final String SP_NAME
        Search parameter constant for name

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

      • SP_PUBLISHER

        public static final String SP_PUBLISHER
        Search parameter constant for 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_DESCRIPTION

        public static final String SP_DESCRIPTION
        Search parameter constant for description

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

      • SP_STATUS

        public static final String SP_STATUS
        Search parameter constant for status

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

      • SP_DATE

        public static final String SP_DATE
        Search parameter constant for 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_SOURCE

        public static final String SP_SOURCE
        Search parameter constant for source

        Description:
        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:
        Type: reference
        Path: ConceptMap.sourceReference

      • SOURCEURI

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SOURCEURI
        Fluent Client search parameter constant for sourceuri

        Description:
        Type: reference
        Path: ConceptMap.sourceUri

      • TARGET

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam TARGET
        Fluent Client search parameter constant for target

        Description:
        Type: reference
        Path: ConceptMap.target[x]

      • SOURCESYSTEM

        public static final ca.uhn.fhir.rest.gclient.UriClientParam SOURCESYSTEM
        Fluent Client search parameter constant for sourcesystem

        Description:
        Type: uri
        Path: ConceptMap.element.codeSystem

      • TARGETSYSTEM

        public static final ca.uhn.fhir.rest.gclient.UriClientParam TARGETSYSTEM
        Fluent Client search parameter constant for targetsystem

        Description:
        Type: uri
        Path: ConceptMap.element.target.codeSystem

      • SOURCECODE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam SOURCECODE
        Fluent Client search parameter constant for sourcecode

        Description:
        Type: token
        Path: ConceptMap.element.code

      • TARGETCODE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam TARGETCODE
        Fluent Client search parameter constant for targetcode

        Description:
        Type: token
        Path: ConceptMap.element.target.code

      • SP_DEPENDSON

        public static final String SP_DEPENDSON
        Search parameter constant for dependson

        Description:
        Type: uri
        Path: ConceptMap.element.target.dependsOn.element

        See Also:
        Constant Field Values
      • DEPENDSON

        public static final ca.uhn.fhir.rest.gclient.UriClientParam DEPENDSON
        Fluent Client search parameter constant for dependson

        Description:
        Type: uri
        Path: ConceptMap.element.target.dependsOn.element

      • SP_PRODUCT

        public static final String SP_PRODUCT
        Search parameter constant for product

        Description:
        Type: uri
        Path: ConceptMap.element.target.product.element

        See Also:
        Constant Field Values
      • PRODUCT

        public static final ca.uhn.fhir.rest.gclient.UriClientParam PRODUCT
        Fluent Client search parameter constant for product

        Description:
        Type: uri
        Path: ConceptMap.element.target.product.element

      • SP_CONTEXT

        public static final String SP_CONTEXT
        Search parameter constant for context

        Description: A use context assigned to the concept map
        Type: token
        Path: ConceptMap.useContext

        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 concept map
        Type: token
        Path: ConceptMap.useContext

      • 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".
      • INCLUDE_SOURCEURI

        public static final ca.uhn.fhir.model.api.Include INCLUDE_SOURCEURI
        Constant for fluent queries to be used to add include statements. Specifies the path value of "ConceptMap:sourceuri".
      • 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".
    • Method Detail

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      • getAllPopulatedChildElementsOfType

        public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
        Specified by:
        getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
      • getUrlElement

        public ca.uhn.fhir.model.primitive.UriDt getUrlElement()
        Gets the value(s) for url (). creating it if it does not exist. Will not return null.

        Definition: An absolute URL 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

      • getUrl

        public String getUrl()
        Gets the value(s) for url (). creating it if it does not exist. This method may return null.

        Definition: An absolute URL 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

      • setUrl

        public ConceptMap setUrl​(ca.uhn.fhir.model.primitive.UriDt theValue)
        Sets the value(s) for url ()

        Definition: An absolute URL 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

      • setUrl

        public ConceptMap setUrl​(String theUri)
        Sets the value for url ()

        Definition: An absolute URL 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

      • getIdentifier

        public IdentifierDt getIdentifier()
        Gets the value(s) for identifier (). creating it if it does not exist. Will not return null.

        Definition: 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.

      • setIdentifier

        public ConceptMap setIdentifier​(IdentifierDt theValue)
        Sets the value(s) for identifier ()

        Definition: 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 ca.uhn.fhir.model.primitive.StringDt getVersionElement()
        Gets the value(s) for version (). creating it if it does not exist. Will not return null.

        Definition: 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 profile author manually and the value should be a timestamp

      • getVersion

        public String getVersion()
        Gets the value(s) for version (). creating it if it does not exist. This method may return null.

        Definition: 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 profile author manually and the value should be a timestamp

      • setVersion

        public ConceptMap setVersion​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for version ()

        Definition: 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 profile author manually and the value should be a timestamp

      • setVersion

        public ConceptMap setVersion​(String theString)
        Sets the value for version ()

        Definition: 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 profile author manually and the value should be a timestamp

      • getNameElement

        public ca.uhn.fhir.model.primitive.StringDt getNameElement()
        Gets the value(s) for name (). creating it if it does not exist. Will not return null.

        Definition: A free text natural language name describing the concept map

      • getName

        public String getName()
        Gets the value(s) for name (). creating it if it does not exist. This method may return null.

        Definition: A free text natural language name describing the concept map

      • setName

        public ConceptMap setName​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for name ()

        Definition: A free text natural language name describing the concept map

      • setName

        public ConceptMap setName​(String theString)
        Sets the value for name ()

        Definition: A free text natural language name describing the concept map

      • getStatusElement

        public ca.uhn.fhir.model.primitive.BoundCodeDt<ConformanceResourceStatusEnumgetStatusElement()
        Gets the value(s) for status (). creating it if it does not exist. Will not return null.

        Definition: The status of the concept map

      • getStatus

        public String getStatus()
        Gets the value(s) for status (). creating it if it does not exist. This method may return null.

        Definition: The status of the concept map

      • getExperimentalElement

        public ca.uhn.fhir.model.primitive.BooleanDt getExperimentalElement()
        Gets the value(s) for experimental (). creating it if it does not exist. Will not return null.

        Definition: This ConceptMap was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage

      • getExperimental

        public Boolean getExperimental()
        Gets the value(s) for experimental (). creating it if it does not exist. This method may return null.

        Definition: This ConceptMap was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage

      • setExperimental

        public ConceptMap setExperimental​(ca.uhn.fhir.model.primitive.BooleanDt theValue)
        Sets the value(s) for experimental ()

        Definition: This ConceptMap was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage

      • setExperimental

        public ConceptMap setExperimental​(boolean theBoolean)
        Sets the value for experimental ()

        Definition: This ConceptMap was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage

      • getPublisherElement

        public ca.uhn.fhir.model.primitive.StringDt getPublisherElement()
        Gets the value(s) for publisher (). creating it if it does not exist. Will not return null.

        Definition: The name of the individual or organization that published the concept map

      • getPublisher

        public String getPublisher()
        Gets the value(s) for publisher (). creating it if it does not exist. This method may return null.

        Definition: The name of the individual or organization that published the concept map

      • setPublisher

        public ConceptMap setPublisher​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for publisher ()

        Definition: The name of the individual or organization that published the concept map

      • setPublisher

        public ConceptMap setPublisher​(String theString)
        Sets the value for publisher ()

        Definition: The name of the individual or organization that published the concept map

      • getContact

        public List<ConceptMap.ContactgetContact()
        Gets the value(s) for contact (). creating it if it does not exist. Will not return null.

        Definition: Contacts to assist a user in finding and communicating with the publisher

      • addContact

        public ConceptMap.Contact addContact()
        Adds and returns a new value for contact ()

        Definition: Contacts to assist a user in finding and communicating with the publisher

      • addContact

        public ConceptMap addContact​(ConceptMap.Contact theValue)
        Adds a given new value for contact ()

        Definition: Contacts to assist a user in finding and communicating with the publisher

        Parameters:
        theValue - The contact to add (must not be null)
      • getContactFirstRep

        public ConceptMap.Contact getContactFirstRep()
        Gets the first repetition for contact (), creating it if it does not already exist.

        Definition: Contacts to assist a user in finding and communicating with the publisher

      • getDateElement

        public ca.uhn.fhir.model.primitive.DateTimeDt getDateElement()
        Gets the value(s) for date (). creating it if it does not exist. Will not return null.

        Definition: The date this version of the concept map was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the concept map changes

      • getDate

        public Date getDate()
        Gets the value(s) for date (). creating it if it does not exist. This method may return null.

        Definition: The date this version of the concept map was published. The date must change when the business version changes, if it does, 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​(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
        Sets the value(s) for date ()

        Definition: The date this version of the concept map was published. The date must change when the business version changes, if it does, 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 theDate,
                                  ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
        Sets the value for date ()

        Definition: The date this version of the concept map was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the concept map changes

      • setDateWithSecondsPrecision

        public ConceptMap setDateWithSecondsPrecision​(Date theDate)
        Sets the value for date ()

        Definition: The date this version of the concept map was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the concept map changes

      • getDescriptionElement

        public ca.uhn.fhir.model.primitive.StringDt getDescriptionElement()
        Gets the value(s) for description (). creating it if it does not exist. Will not return null.

        Definition: A free text natural language description of the use of the concept map - reason for definition, conditions of use, etc.

      • getDescription

        public String getDescription()
        Gets the value(s) for description (). creating it if it does not exist. This method may return null.

        Definition: A free text natural language description of the use of the concept map - reason for definition, conditions of use, etc.

      • setDescription

        public ConceptMap setDescription​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for description ()

        Definition: A free text natural language description of the use of the concept map - reason for definition, conditions of use, etc.

      • setDescription

        public ConceptMap setDescription​(String theString)
        Sets the value for description ()

        Definition: A free text natural language description of the use of the concept map - reason for definition, conditions of use, etc.

      • getUseContext

        public List<CodeableConceptDtgetUseContext()
        Gets the value(s) for useContext (). creating it if it does not exist. Will not return null.

        Definition: 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 of concept map instances.

      • setUseContext

        public ConceptMap setUseContext​(List<CodeableConceptDt> theValue)
        Sets the value(s) for useContext ()

        Definition: 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 of concept map instances.

      • addUseContext

        public CodeableConceptDt addUseContext()
        Adds and returns a new value for useContext ()

        Definition: 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 of concept map instances.

      • addUseContext

        public ConceptMap addUseContext​(CodeableConceptDt theValue)
        Adds a given new value for useContext ()

        Definition: 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 of concept map instances.

        Parameters:
        theValue - The useContext to add (must not be null)
      • getUseContextFirstRep

        public CodeableConceptDt getUseContextFirstRep()
        Gets the first repetition for useContext (), creating it if it does not already exist.

        Definition: 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 of concept map instances.

      • getRequirementsElement

        public ca.uhn.fhir.model.primitive.StringDt getRequirementsElement()
        Gets the value(s) for requirements (). creating it if it does not exist. Will not return null.

        Definition: Explains why this concept map is needed and why it has been constrained as it has

      • getRequirements

        public String getRequirements()
        Gets the value(s) for requirements (). creating it if it does not exist. This method may return null.

        Definition: Explains why this concept map is needed and why it has been constrained as it has

      • setRequirements

        public ConceptMap setRequirements​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for requirements ()

        Definition: Explains why this concept map is needed and why it has been constrained as it has

      • setRequirements

        public ConceptMap setRequirements​(String theString)
        Sets the value for requirements ()

        Definition: Explains why this concept map is needed and why it has been constrained as it has

      • getCopyrightElement

        public ca.uhn.fhir.model.primitive.StringDt getCopyrightElement()
        Gets the value(s) for copyright (). creating it if it does not exist. Will not return null.

        Definition: A copyright statement relating to the concept map and/or its contents

      • getCopyright

        public String getCopyright()
        Gets the value(s) for copyright (). creating it if it does not exist. This method may return null.

        Definition: A copyright statement relating to the concept map and/or its contents

      • setCopyright

        public ConceptMap setCopyright​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for copyright ()

        Definition: A copyright statement relating to the concept map and/or its contents

      • setCopyright

        public ConceptMap setCopyright​(String theString)
        Sets the value for copyright ()

        Definition: A copyright statement relating to the concept map and/or its contents

      • getSource

        public ca.uhn.fhir.model.api.IDatatype getSource()
        Gets the value(s) for source[x] (). creating it if it does not exist. Will not return null.

        Definition: The source value set that specifies the concepts that are being mapped

      • setSource

        public ConceptMap setSource​(ca.uhn.fhir.model.api.IDatatype theValue)
        Sets the value(s) for source[x] ()

        Definition: The source value set that specifies the concepts that are being mapped

      • getTarget

        public ca.uhn.fhir.model.api.IDatatype getTarget()
        Gets the value(s) for target[x] (). creating it if it does not exist. Will not return null.

        Definition: 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

      • setTarget

        public ConceptMap setTarget​(ca.uhn.fhir.model.api.IDatatype theValue)
        Sets the value(s) for target[x] ()

        Definition: 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

      • getElement

        public List<ConceptMap.ElementgetElement()
        Gets the value(s) for element (). creating it if it does not exist. Will not return null.

        Definition: Mappings for an individual concept in the source to one or more concepts in the target

      • setElement

        public ConceptMap setElement​(List<ConceptMap.Element> theValue)
        Sets the value(s) for element ()

        Definition: Mappings for an individual concept in the source to one or more concepts in the target

      • addElement

        public ConceptMap.Element addElement()
        Adds and returns a new value for element ()

        Definition: Mappings for an individual concept in the source to one or more concepts in the target

      • addElement

        public ConceptMap addElement​(ConceptMap.Element theValue)
        Adds a given new value for element ()

        Definition: Mappings for an individual concept in the source to one or more concepts in the target

        Parameters:
        theValue - The element to add (must not be null)
      • getElementFirstRep

        public ConceptMap.Element getElementFirstRep()
        Gets the first repetition for element (), creating it if it does not already exist.

        Definition: Mappings for an individual concept in the source to one or more concepts in the target

      • getResourceName

        public String getResourceName()
        Specified by:
        getResourceName in interface ca.uhn.fhir.model.api.IResource
      • getStructureFhirVersionEnum

        public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
        Specified by:
        getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
        Specified by:
        getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource