Class 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 DomainResource
    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
    • Field Detail

      • url

        protected UriType url
        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.
      • identifier

        protected Identifier identifier
        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.
      • version

        protected StringType 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 profile author manually and the value should be a timestamp.
      • name

        protected StringType name
        A free text natural language name describing the concept map.
      • experimental

        protected BooleanType experimental
        This ConceptMap was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
      • publisher

        protected StringType publisher
        The name of the individual or organization that published the concept map.
      • date

        protected DateTimeType date
        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.
      • description

        protected StringType description
        A free text natural language description of the use of the concept map - reason for definition, conditions of use, etc.
      • useContext

        protected List<CodeableConcept> 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 of concept map instances.
      • requirements

        protected StringType requirements
        Explains why this concept map is needed and why it has been constrained as it has.
      • copyright

        protected StringType copyright
        A copyright statement relating to the concept map and/or its contents.
      • 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.
      • 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.element.system

        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.element.system

      • SP_DEPENDSON

        public static final String SP_DEPENDSON
        Search parameter: dependson

        Description: Reference to element/field/ValueSet mapping depends on
        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: Reference to element/field/ValueSet mapping depends on
        Type: uri
        Path: ConceptMap.element.target.dependsOn.element

      • SP_STATUS

        public static final String SP_STATUS
        Search parameter: 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: 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_URL

        public static final String SP_URL
        Search parameter: 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_TARGET_CODE

        public static final String SP_TARGET_CODE
        Search parameter: target-code

        Description: Code that identifies the target element
        Type: token
        Path: ConceptMap.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.element.target.code

      • SP_VERSION

        public static final String SP_VERSION
        Search parameter: 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_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_PRODUCT

        public static final String SP_PRODUCT
        Search parameter: product

        Description: Reference to element/field/ValueSet mapping depends on
        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: Reference to element/field/ValueSet mapping depends on
        Type: uri
        Path: ConceptMap.element.target.product.element

      • SP_SOURCE_CODE

        public static final String SP_SOURCE_CODE
        Search parameter: source-code

        Description: Identifies element being mapped
        Type: token
        Path: ConceptMap.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.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_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_DESCRIPTION

        public static final String SP_DESCRIPTION
        Search parameter: 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_NAME

        public static final String SP_NAME
        Search parameter: 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_CONTEXT

        public static final String SP_CONTEXT
        Search parameter: 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

      • SP_TARGET

        public static final String SP_TARGET
        Search parameter: target

        Description: Provides context to the mappings
        Type: reference
        Path: ConceptMap.target[x]

        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.target[x]

      • 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_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter: 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_TARGET_SYSTEM

        public static final String SP_TARGET_SYSTEM
        Search parameter: target-system

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

        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.element.target.system

    • Method Detail

      • getUrlElement

        public UriType getUrlElement()
        Returns:
        url (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.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
      • hasUrl

        public boolean hasUrl()
      • setUrlElement

        public ConceptMap setUrlElement​(UriType value)
        Parameters:
        value - url (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.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
      • getUrl

        public String getUrl()
        Returns:
        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 value)
        Parameters:
        value - 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 Identifier getIdentifier()
        Returns:
        identifier (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​(Identifier value)
        Parameters:
        value - identifier (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()
        Returns:
        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 profile author manually and the value should be a timestamp.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
      • setVersionElement

        public ConceptMap setVersionElement​(StringType value)
        Parameters:
        value - 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 profile author manually and the value should be a timestamp.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
      • getVersion

        public String getVersion()
        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 profile author manually and the value should be a timestamp.
      • setVersion

        public ConceptMap setVersion​(String value)
        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 profile author manually and the value should be a timestamp.
      • getNameElement

        public StringType getNameElement()
        Returns:
        name (A free text natural language name describing the concept map.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
      • hasName

        public boolean hasName()
      • setNameElement

        public ConceptMap setNameElement​(StringType value)
        Parameters:
        value - name (A free text natural language name describing the concept map.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
      • getName

        public String getName()
        Returns:
        A free text natural language name describing the concept map.
      • setName

        public ConceptMap setName​(String value)
        Parameters:
        value - A free text natural language name describing the concept map.
      • getExperimentalElement

        public BooleanType getExperimentalElement()
        Returns:
        experimental (This ConceptMap was 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
      • setExperimentalElement

        public ConceptMap setExperimentalElement​(BooleanType value)
        Parameters:
        value - experimental (This ConceptMap was 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()
        Returns:
        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 value)
        Parameters:
        value - This ConceptMap was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
      • getPublisherElement

        public StringType getPublisherElement()
        Returns:
        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
      • setPublisherElement

        public ConceptMap setPublisherElement​(StringType value)
        Parameters:
        value - 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()
        Returns:
        The name of the individual or organization that published the concept map.
      • setPublisher

        public ConceptMap setPublisher​(String value)
        Parameters:
        value - The name of the individual or organization that published the concept map.
      • getDateElement

        public DateTimeType getDateElement()
        Returns:
        date (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.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
      • hasDate

        public boolean hasDate()
      • setDateElement

        public ConceptMap setDateElement​(DateTimeType value)
        Parameters:
        value - date (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.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
      • getDate

        public Date getDate()
        Returns:
        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 value)
        Parameters:
        value - 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 StringType getDescriptionElement()
        Returns:
        description (A free text natural language description of the use of the concept map - reason for definition, conditions of use, etc.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
      • setDescriptionElement

        public ConceptMap setDescriptionElement​(StringType value)
        Parameters:
        value - description (A free text natural language description of the use of the concept map - reason for definition, conditions of use, etc.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
      • getDescription

        public String getDescription()
        Returns:
        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 value)
        Parameters:
        value - A free text natural language description of the use of the concept map - reason for definition, conditions of use, etc.
      • getUseContext

        public List<CodeableConceptgetUseContext()
        Returns:
        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 of concept map instances.)
      • addUseContext

        public CodeableConcept addUseContext()
        Returns:
        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 of concept map instances.)
      • getRequirementsElement

        public StringType getRequirementsElement()
        Returns:
        requirements (Explains why this concept map is needed and why it has been constrained as it has.). This is the underlying object with id, value and extensions. The accessor "getRequirements" gives direct access to the value
      • setRequirementsElement

        public ConceptMap setRequirementsElement​(StringType value)
        Parameters:
        value - requirements (Explains why this concept map is needed and why it has been constrained as it has.). This is the underlying object with id, value and extensions. The accessor "getRequirements" gives direct access to the value
      • getRequirements

        public String getRequirements()
        Returns:
        Explains why this concept map is needed and why it has been constrained as it has.
      • setRequirements

        public ConceptMap setRequirements​(String value)
        Parameters:
        value - Explains why this concept map is needed and why it has been constrained as it has.
      • getCopyrightElement

        public StringType getCopyrightElement()
        Returns:
        copyright (A copyright statement relating to the concept map and/or its contents.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value
      • setCopyrightElement

        public ConceptMap setCopyrightElement​(StringType value)
        Parameters:
        value - copyright (A copyright statement relating to the concept map and/or its contents.). 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.
      • setCopyright

        public ConceptMap setCopyright​(String value)
        Parameters:
        value - A copyright statement relating to the concept map and/or its contents.
      • 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
      • 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
      • setSource

        public ConceptMap setSource​(Type value)
        Parameters:
        value - source (The source value set that specifies the concepts that are being mapped.)
      • 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
      • 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
      • setTarget

        public ConceptMap setTarget​(Type value)
        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.)
      • getProperty

        public Base[] getProperty​(int hash,
                                  String name,
                                  boolean checkValid)
                           throws org.hl7.fhir.exceptions.FHIRException
        Overrides:
        getProperty in class DomainResource
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • makeProperty

        public Base makeProperty​(int hash,
                                 String name)
                          throws org.hl7.fhir.exceptions.FHIRException
        Description copied from class: Base
        make an instance of a property. If the property is a repeating property, make a new instance. if the property is not repeating, return the property
        Overrides:
        makeProperty in class DomainResource
        Returns:
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
        Overrides:
        isEmpty in class DomainResource