Package org.linuxforhealth.fhir.model.resource

Class StructureMap

  • All Implemented Interfaces:
    Visitable
    @Generated("org.linuxforhealth.fhir.tools.CodeGenerator")
public class StructureMap
extends DomainResource
    A Map of relationships between 2 structures that can be used to transform data.

    Maturity level: FMM2 (Trial Use)

    • Method Detail

      • getUrl

        public Uri getUrl()
        An absolute URI that is used to identify this structure 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 structure map is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the structure map is stored on different servers.
        Returns:
        An immutable object of type Uri that is non-null.

      • getIdentifier

        public java.util.List<Identifier> getIdentifier()
        A formal identifier that is used to identify this structure map when it is represented in other formats, or referenced in a specification, model, design or an instance.
        Returns:
        An unmodifiable list containing immutable objects of type Identifier that may be empty.

      • getVersion

        public String getVersion()
        The identifier that is used to identify this version of the structure map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure 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.
        Returns:
        An immutable object of type String that may be null.

      • getName

        public String getName()
        A natural language name identifying the structure map. This name should be usable as an identifier for the module by machine processing applications such as code generation.
        Returns:
        An immutable object of type String that is non-null.

      • getTitle

        public String getTitle()
        A short, descriptive, user-friendly title for the structure map.
        Returns:
        An immutable object of type String that may be null.

      • getStatus

        public PublicationStatus getStatus()
        The status of this structure map. Enables tracking the life-cycle of the content.
        Returns:
        An immutable object of type PublicationStatus that is non-null.

      • getExperimental

        public Boolean getExperimental()
        A Boolean value to indicate that this structure map is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
        Returns:
        An immutable object of type Boolean that may be null.

      • getDate

        public DateTime getDate()
        The date (and optionally time) when the structure 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 structure map changes.
        Returns:
        An immutable object of type DateTime that may be null.

      • getPublisher

        public String getPublisher()
        The name of the organization or individual that published the structure map.
        Returns:
        An immutable object of type String that may be null.

      • getContact

        public java.util.List<ContactDetail> getContact()
        Contact details to assist a user in finding and communicating with the publisher.
        Returns:
        An unmodifiable list containing immutable objects of type ContactDetail that may be empty.

      • getDescription

        public Markdown getDescription()
        A free text natural language description of the structure map from a consumer's perspective.
        Returns:
        An immutable object of type Markdown that may be null.

      • getUseContext

        public java.util.List<UsageContext> getUseContext()
        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 structure map instances.
        Returns:
        An unmodifiable list containing immutable objects of type UsageContext that may be empty.

      • getJurisdiction

        public java.util.List<CodeableConcept> getJurisdiction()
        A legal or geographic region in which the structure map is intended to be used.
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

      • getPurpose

        public Markdown getPurpose()
        Explanation of why this structure map is needed and why it has been designed as it has.
        Returns:
        An immutable object of type Markdown that may be null.

      • getCopyright

        public Markdown getCopyright()
        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 structure map.
        Returns:
        An immutable object of type Markdown that may be null.

      • getStructure

        public java.util.List<StructureMap.Structure> getStructure()
        A structure definition used by this map. The structure definition may describe instances that are converted, or the instances that are produced.
        Returns:
        An unmodifiable list containing immutable objects of type StructureMap.Structure that may be empty.

      • getImport

        public java.util.List<Canonical> getImport()
        Other maps used by this map (canonical URLs).
        Returns:
        An unmodifiable list containing immutable objects of type Canonical that may be empty.

      • getGroup

        public java.util.List<StructureMap.Group> getGroup()
        Organizes the mapping into manageable chunks for human review/ease of maintenance.
        Returns:
        An unmodifiable list containing immutable objects of type StructureMap.Group that is non-empty.

      • accept

        public void accept​(java.lang.String elementName,
                   int elementIndex,
                   Visitor visitor)
        Description copied from interface: Visitable
        Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this: 
         if (visitor.preVisit(this)) {
     visitor.visitStart(elementName, elementIndex, this);
     if (visitor.visit(elementName, elementIndex, this)) {
         // visit children
     }
     visitor.visitEnd(elementName, elementIndex, this);
     visitor.postVisit(this);
 }
        Specified by:
        accept in interface Visitable
        Specified by:
        accept in class AbstractVisitable
        Parameters:
        elementName - the name of the element in the context of this visit
        elementIndex - the index of the element in a list or -1 if it is not contained within a List
        visitor - the visitor to use

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object