Package org.hl7.fhir.dstu2.model

Class StructureDefinition

  • 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 StructureDefinition
extends DomainResource
    A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions, and constraints on resources and data types.
    See Also:
    Serialized Form

    • Method Detail

      • getUrlElement

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

      • setUrl

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

      • getIdentifier

        public List<Identifier> getIdentifier()
        Returns:
        identifier (Formal identifier that is used to identify this StructureDefinition 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 StructureDefinition 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 StructureDefinition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the StructureDefinition author manually.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value

      • setVersionElement

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

      • setVersion

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

      • getNameElement

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

      • getDisplayElement

        public StringType getDisplayElement()
        Returns:
        display (Defined so that applications can use this name when displaying the value of the extension to the user.). This is the underlying object with id, value and extensions. The accessor "getDisplay" gives direct access to the value

      • setDisplayElement

        public StructureDefinition setDisplayElement​(StringType value)
        Parameters:
        value - display (Defined so that applications can use this name when displaying the value of the extension to the user.). This is the underlying object with id, value and extensions. The accessor "getDisplay" gives direct access to the value

      • getDisplay

        public String getDisplay()
        Returns:
        Defined so that applications can use this name when displaying the value of the extension to the user.

      • setDisplay

        public StructureDefinition setDisplay​(String value)
        Parameters:
        value - Defined so that applications can use this name when displaying the value of the extension to the user.

      • getExperimentalElement

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

      • setExperimental

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

      • setPublisherElement

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

      • getDateElement

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

      • setDate

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

      • getDescriptionElement

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

      • setDescriptionElement

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

      • getUseContext

        public List<CodeableConcept> getUseContext()
        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 definitions.)

      • 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 definitions.)

      • getRequirementsElement

        public StringType getRequirementsElement()
        Returns:
        requirements (Explains why this structure definition is needed and why it's 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 StructureDefinition setRequirementsElement​(StringType value)
        Parameters:
        value - requirements (Explains why this structure definition is needed and why it's 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 structure definition is needed and why it's been constrained as it has.

      • getCopyrightElement

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

      • getCode

        public List<Coding> getCode()
        Returns:
        code (A set of terms from external terminologies that may be used to assist with indexing and searching of templates.)

      • hasCode

        public boolean hasCode()

      • addCode

        public Coding addCode()
        Returns:
        code (A set of terms from external terminologies that may be used to assist with indexing and searching of templates.)

      • getFhirVersionElement

        public IdType getFhirVersionElement()
        Returns:
        fhirVersion (The version of the FHIR specification on which this StructureDefinition is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 1.0.2 for this version.). This is the underlying object with id, value and extensions. The accessor "getFhirVersion" gives direct access to the value

      • setFhirVersionElement

        public StructureDefinition setFhirVersionElement​(IdType value)
        Parameters:
        value - fhirVersion (The version of the FHIR specification on which this StructureDefinition is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 1.0.2 for this version.). This is the underlying object with id, value and extensions. The accessor "getFhirVersion" gives direct access to the value

      • getFhirVersion

        public String getFhirVersion()
        Returns:
        The version of the FHIR specification on which this StructureDefinition is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 1.0.2 for this version.

      • setFhirVersion

        public StructureDefinition setFhirVersion​(String value)
        Parameters:
        value - The version of the FHIR specification on which this StructureDefinition is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 1.0.2 for this version.

      • hasKind

        public boolean hasKind()

      • getConstrainedTypeElement

        public CodeType getConstrainedTypeElement()
        Returns:
        constrainedType (The type of type that is being constrained - a data type, an extension, a resource, including abstract ones. If this field is present, it indicates that the structure definition is a constraint. If it is not present, then the structure definition is the definition of a base structure.). This is the underlying object with id, value and extensions. The accessor "getConstrainedType" gives direct access to the value

      • setConstrainedTypeElement

        public StructureDefinition setConstrainedTypeElement​(CodeType value)
        Parameters:
        value - constrainedType (The type of type that is being constrained - a data type, an extension, a resource, including abstract ones. If this field is present, it indicates that the structure definition is a constraint. If it is not present, then the structure definition is the definition of a base structure.). This is the underlying object with id, value and extensions. The accessor "getConstrainedType" gives direct access to the value

      • getConstrainedType

        public String getConstrainedType()
        Returns:
        The type of type that is being constrained - a data type, an extension, a resource, including abstract ones. If this field is present, it indicates that the structure definition is a constraint. If it is not present, then the structure definition is the definition of a base structure.

      • setConstrainedType

        public StructureDefinition setConstrainedType​(String value)
        Parameters:
        value - The type of type that is being constrained - a data type, an extension, a resource, including abstract ones. If this field is present, it indicates that the structure definition is a constraint. If it is not present, then the structure definition is the definition of a base structure.

      • getAbstractElement

        public BooleanType getAbstractElement()
        Returns:
        abstract_ (Whether structure this definition describes is abstract or not - that is, whether an actual exchanged item can ever be of this type.). This is the underlying object with id, value and extensions. The accessor "getAbstract" gives direct access to the value

      • setAbstractElement

        public StructureDefinition setAbstractElement​(BooleanType value)
        Parameters:
        value - abstract_ (Whether structure this definition describes is abstract or not - that is, whether an actual exchanged item can ever be of this type.). This is the underlying object with id, value and extensions. The accessor "getAbstract" gives direct access to the value

      • getAbstract

        public boolean getAbstract()
        Returns:
        Whether structure this definition describes is abstract or not - that is, whether an actual exchanged item can ever be of this type.

      • setAbstract

        public StructureDefinition setAbstract​(boolean value)
        Parameters:
        value - Whether structure this definition describes is abstract or not - that is, whether an actual exchanged item can ever be of this type.

      • getContext

        public List<StringType> getContext()
        Returns:
        context (Identifies the types of resource or data type elements to which the extension can be applied.)

      • addContextElement

        public StringType addContextElement()
        Returns:
        context (Identifies the types of resource or data type elements to which the extension can be applied.)

      • hasContext

        public boolean hasContext​(String value)
        Parameters:
        value - context (Identifies the types of resource or data type elements to which the extension can be applied.)

      • getBaseElement

        public UriType getBaseElement()
        Returns:
        base (An absolute URI that is the base structure from which this set of constraints is derived.). This is the underlying object with id, value and extensions. The accessor "getBase" gives direct access to the value

      • hasBase

        public boolean hasBase()

      • setBaseElement

        public StructureDefinition setBaseElement​(UriType value)
        Parameters:
        value - base (An absolute URI that is the base structure from which this set of constraints is derived.). This is the underlying object with id, value and extensions. The accessor "getBase" gives direct access to the value

      • getBase

        public String getBase()
        Returns:
        An absolute URI that is the base structure from which this set of constraints is derived.

      • setBase

        public StructureDefinition setBase​(String value)
        Parameters:
        value - An absolute URI that is the base structure from which this set of constraints is derived.

      • isEmpty

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