Class StructureMap

  • 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 StructureMap
    extends DomainResource
    A Map of relationships between 2 structures that can be used to transform data.
    See Also:
    Serialized Form
    • Field Detail

      • url

        protected UriType url
        An absolute URL that is used to identify this structure 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 structure map is (or will be) published.
      • identifier

        protected List<Identifier> identifier
        Formal identifier that is used to identify this StructureMap when it is represented in other formats, or referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI), (if it's not possible to use the literal URI).
      • version

        protected StringType version
        The identifier that is used to identify this version of the StructureMap when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the StructureMap author manually.
      • name

        protected StringType name
        A free text natural language name identifying the StructureMap.
      • experimental

        protected BooleanType experimental
        This StructureMap 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 structure map.
      • date

        protected DateTimeType date
        The date this version of the structure 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 structure map changes.
      • description

        protected StringType description
        A free text natural language description of the StructureMap and its use.
      • 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 structure maps.
      • requirements

        protected StringType requirements
        Explains why this structure map is needed and why it's been designed as it has.
      • copyright

        protected StringType copyright
        A copyright statement relating to the structure map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the details of the constraints and mappings.
      • SP_STATUS

        public static final String SP_STATUS
        Search parameter: status

        Description: The current status of the profile
        Type: token
        Path: StructureMap.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 profile
        Type: token
        Path: StructureMap.status

      • SP_DESCRIPTION

        public static final String SP_DESCRIPTION
        Search parameter: description

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

      • SP_NAME

        public static final String SP_NAME
        Search parameter: name

        Description: Name of the profile
        Type: string
        Path: StructureMap.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 profile
        Type: string
        Path: StructureMap.name

      • SP_CONTEXT

        public static final String SP_CONTEXT
        Search parameter: context

        Description: A use context assigned to the structure
        Type: token
        Path: StructureMap.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 structure
        Type: token
        Path: StructureMap.useContext

      • SP_EXPERIMENTAL

        public static final String SP_EXPERIMENTAL
        Search parameter: experimental

        Description: Whether the map is defined purely for experimental reasons
        Type: token
        Path: StructureMap.experimental

        See Also:
        Constant Field Values
      • EXPERIMENTAL

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

        Description: Whether the map is defined purely for experimental reasons
        Type: token
        Path: StructureMap.experimental

      • SP_DATE

        public static final String SP_DATE
        Search parameter: date

        Description: The profile publication date
        Type: date
        Path: StructureMap.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 profile publication date
        Type: date
        Path: StructureMap.date

      • SP_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter: identifier

        Description: The identifier of the profile
        Type: token
        Path: StructureMap.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: The identifier of the profile
        Type: token
        Path: StructureMap.identifier

      • SP_URL

        public static final String SP_URL
        Search parameter: url

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

      • SP_PUBLISHER

        public static final String SP_PUBLISHER
        Search parameter: publisher

        Description: Name of the publisher of the profile
        Type: string
        Path: StructureMap.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 profile
        Type: string
        Path: StructureMap.publisher

      • SP_VERSION

        public static final String SP_VERSION
        Search parameter: version

        Description: The version identifier of the profile
        Type: token
        Path: StructureMap.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 profile
        Type: token
        Path: StructureMap.version

    • Method Detail

      • getUrlElement

        public UriType getUrlElement()
        Returns:
        url (An absolute URL that is used to identify this structure 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 structure 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 StructureMap setUrlElement​(UriType value)
        Parameters:
        value - url (An absolute URL that is used to identify this structure 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 structure 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 structure 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 structure map is (or will be) published.
      • setUrl

        public StructureMap setUrl​(String value)
        Parameters:
        value - An absolute URL that is used to identify this structure 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 structure map is (or will be) published.
      • getIdentifier

        public List<IdentifiergetIdentifier()
        Returns:
        identifier (Formal identifier that is used to identify this StructureMap when it is represented in other formats, or referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI), (if it's not possible to use the literal URI).)
      • addIdentifier

        public Identifier addIdentifier()
        Returns:
        identifier (Formal identifier that is used to identify this StructureMap when it is represented in other formats, or referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI), (if it's not possible to use the literal URI).)
      • getVersionElement

        public StringType getVersionElement()
        Returns:
        version (The identifier that is used to identify this version of the StructureMap when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the StructureMap author manually.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
      • setVersionElement

        public StructureMap setVersionElement​(StringType value)
        Parameters:
        value - version (The identifier that is used to identify this version of the StructureMap when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the StructureMap author manually.). 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 StructureMap when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the StructureMap author manually.
      • setVersion

        public StructureMap setVersion​(String value)
        Parameters:
        value - The identifier that is used to identify this version of the StructureMap when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the StructureMap author manually.
      • getNameElement

        public StringType getNameElement()
        Returns:
        name (A free text natural language name identifying the StructureMap.). 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 StructureMap setNameElement​(StringType value)
        Parameters:
        value - name (A free text natural language name identifying the StructureMap.). 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 identifying the StructureMap.
      • setName

        public StructureMap setName​(String value)
        Parameters:
        value - A free text natural language name identifying the StructureMap.
      • getExperimentalElement

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

        public StructureMap setExperimental​(boolean value)
        Parameters:
        value - This StructureMap 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 structure map.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value
      • setPublisherElement

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

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

        public DateTimeType getDateElement()
        Returns:
        date (The date this version of the structure 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 structure 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 StructureMap setDateElement​(DateTimeType value)
        Parameters:
        value - date (The date this version of the structure 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 structure 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 structure 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 structure map changes.
      • setDate

        public StructureMap setDate​(Date value)
        Parameters:
        value - The date this version of the structure 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 structure map changes.
      • getDescriptionElement

        public StringType getDescriptionElement()
        Returns:
        description (A free text natural language description of the StructureMap and its use.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
      • setDescriptionElement

        public StructureMap setDescriptionElement​(StringType value)
        Parameters:
        value - description (A free text natural language description of the StructureMap and its use.). 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 StructureMap and its use.
      • setDescription

        public StructureMap setDescription​(String value)
        Parameters:
        value - A free text natural language description of the StructureMap and its use.
      • 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 structure maps.)
      • 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 structure maps.)
      • getRequirementsElement

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

        public StructureMap setRequirementsElement​(StringType value)
        Parameters:
        value - requirements (Explains why this structure map is needed and why it's been designed 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 structure map is needed and why it's been designed as it has.
      • setRequirements

        public StructureMap setRequirements​(String value)
        Parameters:
        value - Explains why this structure map is needed and why it's been designed as it has.
      • getCopyrightElement

        public StringType getCopyrightElement()
        Returns:
        copyright (A copyright statement relating to the structure map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the details of the constraints and mappings.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value
      • setCopyrightElement

        public StructureMap setCopyrightElement​(StringType value)
        Parameters:
        value - copyright (A copyright statement relating to the structure map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the details of the constraints and mappings.). 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 structure map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the details of the constraints and mappings.
      • setCopyright

        public StructureMap setCopyright​(String value)
        Parameters:
        value - A copyright statement relating to the structure map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the details of the constraints and mappings.
      • hasImport

        public boolean hasImport​(String value)
        Parameters:
        value - import_ (Other maps used by this map (canonical URLs).)
      • 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