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
    • Field Detail

      • url

        protected UriType 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.
      • identifier

        protected List<Identifier> 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).
      • version

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

        protected StringType name
        A free text natural language name identifying the StructureDefinition.
      • display

        protected StringType display
        Defined so that applications can use this name when displaying the value of the extension to the user.
      • experimental

        protected BooleanType experimental
        This StructureDefinition 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 definition.
      • date

        protected DateTimeType 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.
      • description

        protected StringType description
        A free text natural language description of the StructureDefinition 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 definitions.
      • requirements

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

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

        protected List<Coding> code
        A set of terms from external terminologies that may be used to assist with indexing and searching of templates.
      • fhirVersion

        protected IdType 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.4.0 for this version.
      • abstract_

        protected BooleanType abstract_
        Whether structure this definition describes is abstract or not - that is, whether an actual exchanged item can ever be of this type.
      • context

        protected List<StringType> context
        Identifies the types of resource or data type elements to which the extension can be applied.
      • baseType

        protected CodeType baseType
        The type of type that this structure is derived from - a data type, an extension, a resource, including abstract ones. If this field is present, it indicates that the structure definition is deriving from this type. If it is not present, then the structure definition is the definition of a base abstract structure.
      • baseDefinition

        protected UriType baseDefinition
        An absolute URI that is the base structure from which this type is derived, either by specialization or constraint.
      • SP_ABSTRACT

        public static final String SP_ABSTRACT
        Search parameter: abstract

        Description: Whether the structure is abstract
        Type: token
        Path: StructureDefinition.abstract

        See Also:
        Constant Field Values
      • ABSTRACT

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

        Description: Whether the structure is abstract
        Type: token
        Path: StructureDefinition.abstract

      • SP_STATUS

        public static final String SP_STATUS
        Search parameter: status

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

      • SP_EXPERIMENTAL

        public static final String SP_EXPERIMENTAL
        Search parameter: experimental

        Description: If for testing purposes, not real usage
        Type: token
        Path: StructureDefinition.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: If for testing purposes, not real usage
        Type: token
        Path: StructureDefinition.experimental

      • SP_DISPLAY

        public static final String SP_DISPLAY
        Search parameter: display

        Description: Use this name when displaying the value
        Type: string
        Path: StructureDefinition.display

        See Also:
        Constant Field Values
      • DISPLAY

        public static final ca.uhn.fhir.rest.gclient.StringClientParam DISPLAY
        Fluent Client search parameter constant for display

        Description: Use this name when displaying the value
        Type: string
        Path: StructureDefinition.display

      • SP_EXT_CONTEXT

        public static final String SP_EXT_CONTEXT
        Search parameter: ext-context

        Description: Where the extension can be used in instances
        Type: string
        Path: StructureDefinition.context

        See Also:
        Constant Field Values
      • EXT_CONTEXT

        public static final ca.uhn.fhir.rest.gclient.StringClientParam EXT_CONTEXT
        Fluent Client search parameter constant for ext-context

        Description: Where the extension can be used in instances
        Type: string
        Path: StructureDefinition.context

      • SP_CODE

        public static final String SP_CODE
        Search parameter: code

        Description: A code for the profile
        Type: token
        Path: StructureDefinition.code

        See Also:
        Constant Field Values
      • CODE

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

        Description: A code for the profile
        Type: token
        Path: StructureDefinition.code

      • SP_DATE

        public static final String SP_DATE
        Search parameter: date

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

      • SP_TYPE

        public static final String SP_TYPE
        Search parameter: type

        Description: Any datatype or resource, including abstract ones
        Type: token
        Path: StructureDefinition.baseType

        See Also:
        Constant Field Values
      • TYPE

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

        Description: Any datatype or resource, including abstract ones
        Type: token
        Path: StructureDefinition.baseType

      • SP_URL

        public static final String SP_URL
        Search parameter: url

        Description: Absolute URL used to reference this StructureDefinition
        Type: uri
        Path: StructureDefinition.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: Absolute URL used to reference this StructureDefinition
        Type: uri
        Path: StructureDefinition.url

      • SP_KIND

        public static final String SP_KIND
        Search parameter: kind

        Description: datatype | resource | logical
        Type: token
        Path: StructureDefinition.kind

        See Also:
        Constant Field Values
      • KIND

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

        Description: datatype | resource | logical
        Type: token
        Path: StructureDefinition.kind

      • SP_VERSION

        public static final String SP_VERSION
        Search parameter: version

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

      • SP_PUBLISHER

        public static final String SP_PUBLISHER
        Search parameter: publisher

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

      • SP_DERIVATION

        public static final String SP_DERIVATION
        Search parameter: derivation

        Description: specialization | constraint - How relates to base definition
        Type: token
        Path: StructureDefinition.derivation

        See Also:
        Constant Field Values
      • DERIVATION

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

        Description: specialization | constraint - How relates to base definition
        Type: token
        Path: StructureDefinition.derivation

      • SP_BASE_PATH

        public static final String SP_BASE_PATH
        Search parameter: base-path

        Description: Path that identifies the base element
        Type: token
        Path: StructureDefinition.snapshot.element.base.path, StructureDefinition.differential.element.base.path

        See Also:
        Constant Field Values
      • BASE_PATH

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam BASE_PATH
        Fluent Client search parameter constant for base-path

        Description: Path that identifies the base element
        Type: token
        Path: StructureDefinition.snapshot.element.base.path, StructureDefinition.differential.element.base.path

      • SP_VALUESET

        public static final String SP_VALUESET
        Search parameter: valueset

        Description: A vocabulary binding reference
        Type: reference
        Path: StructureDefinition.snapshot.element.binding.valueSet[x]

        See Also:
        Constant Field Values
      • VALUESET

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

        Description: A vocabulary binding reference
        Type: reference
        Path: StructureDefinition.snapshot.element.binding.valueSet[x]

      • INCLUDE_VALUESET

        public static final ca.uhn.fhir.model.api.Include INCLUDE_VALUESET
        Constant for fluent queries to be used to add include statements. Specifies the path value of "StructureDefinition:valueset".
      • SP_CONTEXT_TYPE

        public static final String SP_CONTEXT_TYPE
        Search parameter: context-type

        Description: resource | datatype | extension
        Type: token
        Path: StructureDefinition.contextType

        See Also:
        Constant Field Values
      • CONTEXT_TYPE

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

        Description: resource | datatype | extension
        Type: token
        Path: StructureDefinition.contextType

      • SP_DESCRIPTION

        public static final String SP_DESCRIPTION
        Search parameter: description

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

      • SP_NAME

        public static final String SP_NAME
        Search parameter: name

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

      • SP_BASE

        public static final String SP_BASE
        Search parameter: base

        Description: Definition that this type is constrained/specialized from
        Type: uri
        Path: StructureDefinition.baseDefinition

        See Also:
        Constant Field Values
      • BASE

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

        Description: Definition that this type is constrained/specialized from
        Type: uri
        Path: StructureDefinition.baseDefinition

      • SP_CONTEXT

        public static final String SP_CONTEXT
        Search parameter: context

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

      • SP_PATH

        public static final String SP_PATH
        Search parameter: path

        Description: A path that is constrained in the profile
        Type: token
        Path: StructureDefinition.snapshot.element.path, StructureDefinition.differential.element.path

        See Also:
        Constant Field Values
      • PATH

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

        Description: A path that is constrained in the profile
        Type: token
        Path: StructureDefinition.snapshot.element.path, StructureDefinition.differential.element.path

      • SP_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter: identifier

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

    • 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<IdentifiergetIdentifier()
        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<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 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<CodinggetCode()
        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.4.0 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.4.0 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.4.0 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.4.0 for this version.
      • hasKind

        public boolean hasKind()
      • 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<StringTypegetContext()
        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.)
      • getBaseTypeElement

        public CodeType getBaseTypeElement()
        Returns:
        baseType (The type of type that this structure is derived from - a data type, an extension, a resource, including abstract ones. If this field is present, it indicates that the structure definition is deriving from this type. If it is not present, then the structure definition is the definition of a base abstract structure.). This is the underlying object with id, value and extensions. The accessor "getBaseType" gives direct access to the value
      • setBaseTypeElement

        public StructureDefinition setBaseTypeElement​(CodeType value)
        Parameters:
        value - baseType (The type of type that this structure is derived from - a data type, an extension, a resource, including abstract ones. If this field is present, it indicates that the structure definition is deriving from this type. If it is not present, then the structure definition is the definition of a base abstract structure.). This is the underlying object with id, value and extensions. The accessor "getBaseType" gives direct access to the value
      • getBaseType

        public String getBaseType()
        Returns:
        The type of type that this structure is derived from - a data type, an extension, a resource, including abstract ones. If this field is present, it indicates that the structure definition is deriving from this type. If it is not present, then the structure definition is the definition of a base abstract structure.
      • setBaseType

        public StructureDefinition setBaseType​(String value)
        Parameters:
        value - The type of type that this structure is derived from - a data type, an extension, a resource, including abstract ones. If this field is present, it indicates that the structure definition is deriving from this type. If it is not present, then the structure definition is the definition of a base abstract structure.
      • getBaseDefinitionElement

        public UriType getBaseDefinitionElement()
        Returns:
        baseDefinition (An absolute URI that is the base structure from which this type is derived, either by specialization or constraint.). This is the underlying object with id, value and extensions. The accessor "getBaseDefinition" gives direct access to the value
      • setBaseDefinitionElement

        public StructureDefinition setBaseDefinitionElement​(UriType value)
        Parameters:
        value - baseDefinition (An absolute URI that is the base structure from which this type is derived, either by specialization or constraint.). This is the underlying object with id, value and extensions. The accessor "getBaseDefinition" gives direct access to the value
      • getBaseDefinition

        public String getBaseDefinition()
        Returns:
        An absolute URI that is the base structure from which this type is derived, either by specialization or constraint.
      • setBaseDefinition

        public StructureDefinition setBaseDefinition​(String value)
        Parameters:
        value - An absolute URI that is the base structure from which this type is derived, either by specialization or constraint.
      • 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