Class ConceptMap2

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 ConceptMap2 extends CanonicalResource
A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models.
See Also:
  • Field Details

    • url

      protected UriType url
      An absolute URI that is used to identify this concept map when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this concept map is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the concept map is stored on different servers.
    • 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.
    • 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 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.
    • name

      protected StringType 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.
    • title

      protected StringType title
      A short, descriptive, user-friendly title for the concept map.
    • status

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

      protected DateTimeType date
      The date (and optionally time) when the concept map was published. The date must change 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.
    • publisher

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

      Contact details to assist a user in finding and communicating with the publisher.
    • description

      A free text natural language description of the concept map from a consumer's perspective.
    • useContext

      The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate concept map instances.
    • jurisdiction

      A legal or geographic region in which the concept map is intended to be used.
    • purpose

      protected MarkdownType purpose
      Explanation of why this concept map is needed and why it has been designed as it has.
    • source

      protected DataType source
      Identifier for the source value set that contains the concepts that are being mapped and provides context for the mappings.
    • target

      protected DataType target
      The target value set provides context for 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

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

      public static final String SP_CONTEXT_QUANTITY
      Search parameter: context-quantity

      Description: A quantity- or range-valued use context assigned to the concept map
      Type: quantity
      Path: (ConceptMap2.useContext.value as Quantity) | (ConceptMap2.useContext.value as Range)

      See Also:
    • CONTEXT_QUANTITY

      public static final ca.uhn.fhir.rest.gclient.QuantityClientParam CONTEXT_QUANTITY
      Fluent Client search parameter constant for context-quantity

      Description: A quantity- or range-valued use context assigned to the concept map
      Type: quantity
      Path: (ConceptMap2.useContext.value as Quantity) | (ConceptMap2.useContext.value as Range)

    • SP_CONTEXT_TYPE_QUANTITY

      public static final String SP_CONTEXT_TYPE_QUANTITY
      Search parameter: context-type-quantity

      Description: A use context type and quantity- or range-based value assigned to the concept map
      Type: composite
      Path: ConceptMap2.useContext

      See Also:
    • CONTEXT_TYPE_QUANTITY

      public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.QuantityClientParam> CONTEXT_TYPE_QUANTITY
      Fluent Client search parameter constant for context-type-quantity

      Description: A use context type and quantity- or range-based value assigned to the concept map
      Type: composite
      Path: ConceptMap2.useContext

    • SP_CONTEXT_TYPE_VALUE

      public static final String SP_CONTEXT_TYPE_VALUE
      Search parameter: context-type-value

      Description: A use context type and value assigned to the concept map
      Type: composite
      Path: ConceptMap2.useContext

      See Also:
    • CONTEXT_TYPE_VALUE

      public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam> CONTEXT_TYPE_VALUE
      Fluent Client search parameter constant for context-type-value

      Description: A use context type and value assigned to the concept map
      Type: composite
      Path: ConceptMap2.useContext

    • SP_CONTEXT_TYPE

      public static final String SP_CONTEXT_TYPE
      Search parameter: context-type

      Description: A type of use context assigned to the concept map
      Type: token
      Path: ConceptMap2.useContext.code

      See Also:
    • CONTEXT_TYPE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT_TYPE
      Fluent Client search parameter constant for context-type

      Description: A type of use context assigned to the concept map
      Type: token
      Path: ConceptMap2.useContext.code

    • SP_CONTEXT

      public static final String SP_CONTEXT
      Search parameter: context

      Description: A use context assigned to the concept map
      Type: token
      Path: (ConceptMap2.useContext.value as CodeableConcept)

      See Also:
    • 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: (ConceptMap2.useContext.value as CodeableConcept)

    • SP_DATE

      public static final String SP_DATE
      Search parameter: date

      Description: The concept map publication date
      Type: date
      Path: ConceptMap2.date

      See Also:
    • 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: ConceptMap2.date

    • SP_DEPENDSON

      public static final String SP_DEPENDSON
      Search parameter: dependson

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

      See Also:
    • 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: ConceptMap2.group.element.target.dependsOn.property

    • SP_DESCRIPTION

      public static final String SP_DESCRIPTION
      Search parameter: description

      Description: The description of the concept map
      Type: string
      Path: ConceptMap2.description

      See Also:
    • 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: ConceptMap2.description

    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: identifier

      Description: External identifier for the concept map
      Type: token
      Path: ConceptMap2.identifier

      See Also:
    • 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: ConceptMap2.identifier

    • SP_JURISDICTION

      public static final String SP_JURISDICTION
      Search parameter: jurisdiction

      Description: Intended jurisdiction for the concept map
      Type: token
      Path: ConceptMap2.jurisdiction

      See Also:
    • 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: ConceptMap2.jurisdiction

    • SP_NAME

      public static final String SP_NAME
      Search parameter: name

      Description: Computationally friendly name of the concept map
      Type: string
      Path: ConceptMap2.name

      See Also:
    • 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: ConceptMap2.name

    • SP_OTHER

      public static final String SP_OTHER
      Search parameter: other

      Description: canonical reference to an additional ConceptMap2 to use for mapping if the source concept is unmapped
      Type: reference
      Path: ConceptMap2.group.unmapped.url

      See Also:
    • OTHER

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

      Description: canonical reference to an additional ConceptMap2 to use for mapping if the source concept is unmapped
      Type: reference
      Path: ConceptMap2.group.unmapped.url

    • INCLUDE_OTHER

      public static final ca.uhn.fhir.model.api.Include INCLUDE_OTHER
      Constant for fluent queries to be used to add include statements. Specifies the path value of "ConceptMap2:other".
    • SP_PRODUCT

      public static final String SP_PRODUCT
      Search parameter: product

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

      See Also:
    • 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: ConceptMap2.group.element.target.product.property

    • SP_PUBLISHER

      public static final String SP_PUBLISHER
      Search parameter: publisher

      Description: Name of the publisher of the concept map
      Type: string
      Path: ConceptMap2.publisher

      See Also:
    • 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: ConceptMap2.publisher

    • SP_SOURCE_CODE

      public static final String SP_SOURCE_CODE
      Search parameter: source-code

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

      See Also:
    • 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: ConceptMap2.group.element.code

    • SP_SOURCE_SYSTEM

      public static final String SP_SOURCE_SYSTEM
      Search parameter: source-system

      Description: Source system where concepts to be mapped are defined
      Type: uri
      Path: ConceptMap2.group.source

      See Also:
    • SOURCE_SYSTEM

      public static final ca.uhn.fhir.rest.gclient.UriClientParam SOURCE_SYSTEM
      Fluent Client search parameter constant for source-system

      Description: Source system where concepts to be mapped are defined
      Type: uri
      Path: ConceptMap2.group.source

    • SP_SOURCE_URI

      public static final String SP_SOURCE_URI
      Search parameter: source-uri

      Description: The source value set that contains the concepts that are being mapped
      Type: reference
      Path: (ConceptMap2.source as uri)

      See Also:
    • SOURCE_URI

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SOURCE_URI
      Fluent Client search parameter constant for source-uri

      Description: The source value set that contains the concepts that are being mapped
      Type: reference
      Path: (ConceptMap2.source as uri)

    • 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 "ConceptMap2:source-uri".
    • SP_SOURCE

      public static final String SP_SOURCE
      Search parameter: source

      Description: The source value set that contains the concepts that are being mapped
      Type: reference
      Path: (ConceptMap2.source as canonical)

      See Also:
    • SOURCE

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

      Description: The source value set that contains the concepts that are being mapped
      Type: reference
      Path: (ConceptMap2.source as canonical)

    • 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 "ConceptMap2:source".
    • SP_STATUS

      public static final String SP_STATUS
      Search parameter: status

      Description: The current status of the concept map
      Type: token
      Path: ConceptMap2.status

      See Also:
    • 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: ConceptMap2.status

    • SP_TARGET_CODE

      public static final String SP_TARGET_CODE
      Search parameter: target-code

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

      See Also:
    • 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: ConceptMap2.group.element.target.code

    • SP_TARGET_SYSTEM

      public static final String SP_TARGET_SYSTEM
      Search parameter: target-system

      Description: Target system that the concepts are to be mapped to
      Type: uri
      Path: ConceptMap2.group.target

      See Also:
    • TARGET_SYSTEM

      public static final ca.uhn.fhir.rest.gclient.UriClientParam TARGET_SYSTEM
      Fluent Client search parameter constant for target-system

      Description: Target system that the concepts are to be mapped to
      Type: uri
      Path: ConceptMap2.group.target

    • SP_TARGET_URI

      public static final String SP_TARGET_URI
      Search parameter: target-uri

      Description: The target value set which provides context for the mappings
      Type: reference
      Path: (ConceptMap2.target as uri)

      See Also:
    • TARGET_URI

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

      Description: The target value set which provides context for the mappings
      Type: reference
      Path: (ConceptMap2.target as uri)

    • 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 "ConceptMap2:target-uri".
    • SP_TARGET

      public static final String SP_TARGET
      Search parameter: target

      Description: The target value set which provides context for the mappings
      Type: reference
      Path: (ConceptMap2.target as canonical)

      See Also:
    • TARGET

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

      Description: The target value set which provides context for the mappings
      Type: reference
      Path: (ConceptMap2.target as canonical)

    • 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 "ConceptMap2:target".
    • SP_TITLE

      public static final String SP_TITLE
      Search parameter: title

      Description: The human-friendly name of the concept map
      Type: string
      Path: ConceptMap2.title

      See Also:
    • 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: ConceptMap2.title

    • SP_URL

      public static final String SP_URL
      Search parameter: url

      Description: The uri that identifies the concept map
      Type: uri
      Path: ConceptMap2.url

      See Also:
    • 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: ConceptMap2.url

    • SP_VERSION

      public static final String SP_VERSION
      Search parameter: version

      Description: The business version of the concept map
      Type: token
      Path: ConceptMap2.version

      See Also:
    • 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: ConceptMap2.version

  • Constructor Details

  • Method Details