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 MetadataResource
    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

      • identifier

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

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

        protected MarkdownType copyright
        A copyright statement relating to the concept map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the concept map.
      • 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_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_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter: identifier

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

      • SP_PRODUCT

        public static final String SP_PRODUCT
        Search parameter: product

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

        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 property mapping depends on
        Type: uri
        Path: ConceptMap.group.element.target.product.property

      • SP_OTHER

        public static final String SP_OTHER
        Search parameter: other

        Description: Canonical URL for other concept map
        Type: uri
        Path: ConceptMap.group.unmapped.url

        See Also:
        Constant Field Values
      • OTHER

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

        Description: Canonical URL for other concept map
        Type: uri
        Path: ConceptMap.group.unmapped.url

      • 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.group.target

        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.group.target

      • SP_DEPENDSON

        public static final String SP_DEPENDSON
        Search parameter: dependson

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

        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 property mapping depends on
        Type: uri
        Path: ConceptMap.group.element.target.dependsOn.property

      • SP_JURISDICTION

        public static final String SP_JURISDICTION
        Search parameter: jurisdiction

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

        See Also:
        Constant Field Values
      • 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: ConceptMap.jurisdiction

      • SP_DESCRIPTION

        public static final String SP_DESCRIPTION
        Search parameter: description

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

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

        public static final String SP_TITLE
        Search parameter: title

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

        See Also:
        Constant Field Values
      • 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: ConceptMap.title

      • SP_VERSION

        public static final String SP_VERSION
        Search parameter: version

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

      • SP_URL

        public static final String SP_URL
        Search parameter: url

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

      • SP_TARGET

        public static final String SP_TARGET
        Search parameter: target

        Description: Provides context to the mappings
        Type: reference
        Path: ConceptMap.targetReference

        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.targetReference

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

        public static final String SP_SOURCE_CODE
        Search parameter: source-code

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

        public static final String SP_NAME
        Search parameter: name

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

      • 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_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.group.source

        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.group.source

      • 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.group.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.group.element.target.code

      • SP_STATUS

        public static final String SP_STATUS
        Search parameter: status

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

      • SP_TARGET_URI

        public static final String SP_TARGET_URI
        Search parameter: target-uri

        Description: Provides context to the mappings
        Type: reference
        Path: ConceptMap.targetUri

        See Also:
        Constant Field Values
      • TARGET_URI

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

        Description: Provides context to the mappings
        Type: reference
        Path: ConceptMap.targetUri

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