Class StructureDefinition

java.lang.Object
ca.uhn.fhir.model.api.BaseElement
ca.uhn.fhir.model.dstu2.resource.BaseResource
ca.uhn.fhir.model.dstu2.resource.StructureDefinition
All Implemented Interfaces:
ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource

public class StructureDefinition extends BaseResource implements ca.uhn.fhir.model.api.IResource
HAPI/FHIR StructureDefinition Resource (conformance.content)

Definition: 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.

Requirements:

Profile Definition: http://hl7.org/fhir/profiles/StructureDefinition

See Also:
Serialized Form
  • Field Details

    • SP_URL

      public static final String SP_URL
      Search parameter constant for url

      Description:
      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:
      Type: uri
      Path: StructureDefinition.url

    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter constant for 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

    • SP_VERSION

      public static final String SP_VERSION
      Search parameter constant for 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_NAME

      public static final String SP_NAME
      Search parameter constant for 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_PUBLISHER

      public static final String SP_PUBLISHER
      Search parameter constant for 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_DESCRIPTION

      public static final String SP_DESCRIPTION
      Search parameter constant for 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_STATUS

      public static final String SP_STATUS
      Search parameter constant for 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_DATE

      public static final String SP_DATE
      Search parameter constant for 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_CODE

      public static final String SP_CODE
      Search parameter constant for 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_VALUESET

      public static final String SP_VALUESET
      Search parameter constant for 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]

    • SP_TYPE

      public static final String SP_TYPE
      Search parameter constant for type

      Description:
      Type: token
      Path: StructureDefinition.constrainedType

      See Also:
      Constant Field Values
    • TYPE

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

      Description:
      Type: token
      Path: StructureDefinition.constrainedType

    • SP_KIND

      public static final String SP_KIND
      Search parameter constant for kind

      Description:
      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:
      Type: token
      Path: StructureDefinition.kind

    • SP_PATH

      public static final String SP_PATH
      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

      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_CONTEXT

      public static final String SP_CONTEXT
      Search parameter constant for 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_DISPLAY

      public static final String SP_DISPLAY
      Search parameter constant for display

      Description:
      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:
      Type: string
      Path: StructureDefinition.display

    • SP_EXPERIMENTAL

      public static final String SP_EXPERIMENTAL
      Search parameter constant for experimental

      Description:
      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:
      Type: token
      Path: StructureDefinition.experimental

    • SP_ABSTRACT

      public static final String SP_ABSTRACT
      Search parameter constant for abstract

      Description:
      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:
      Type: token
      Path: StructureDefinition.abstract

    • SP_CONTEXT_TYPE

      public static final String SP_CONTEXT_TYPE
      Search parameter constant for context-type

      Description:
      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:
      Type: token
      Path: StructureDefinition.contextType

    • SP_EXT_CONTEXT

      public static final String SP_EXT_CONTEXT
      Search parameter constant for ext-context

      Description:
      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:
      Type: string
      Path: StructureDefinition.context

    • SP_BASE

      public static final String SP_BASE
      Search parameter constant for base

      Description:
      Type: uri
      Path: StructureDefinition.base

      See Also:
      Constant Field Values
    • BASE

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

      Description:
      Type: uri
      Path: StructureDefinition.base

    • SP_BASE_PATH

      public static final String SP_BASE_PATH
      Search parameter constant for base-path

      Description:
      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:
      Type: token
      Path: StructureDefinition.snapshot.element.base.path | StructureDefinition.differential.element.base.path

    • 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".
  • Constructor Details

  • Method Details

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    • getAllPopulatedChildElementsOfType

      public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
      Specified by:
      getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
    • getUrlElement

      public ca.uhn.fhir.model.primitive.UriDt getUrlElement()
      Gets the value(s) for url (id). creating it if it does not exist. Will not return null.

      Definition: 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

    • getUrl

      public String getUrl()
      Gets the value(s) for url (id). creating it if it does not exist. This method may return null.

      Definition: 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(ca.uhn.fhir.model.primitive.UriDt theValue)
      Sets the value(s) for url (id)

      Definition: 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 theUri)
      Sets the value for url (id)

      Definition: 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

      Gets the value(s) for identifier (id). creating it if it does not exist. Will not return null.

      Definition: 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)

    • setIdentifier

      Sets the value(s) for identifier (id)

      Definition: 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

      Adds and returns a new value for identifier (id)

      Definition: 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

      Adds a given new value for identifier (id)

      Definition: 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)

      Parameters:
      theValue - The identifier to add (must not be null)
    • getIdentifierFirstRep

      Gets the first repetition for identifier (id), creating it if it does not already exist.

      Definition: 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 ca.uhn.fhir.model.primitive.StringDt getVersionElement()
      Gets the value(s) for version (id.version). creating it if it does not exist. Will not return null.

      Definition: 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

    • getVersion

      public String getVersion()
      Gets the value(s) for version (id.version). creating it if it does not exist. This method may return null.

      Definition: 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(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for version (id.version)

      Definition: 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 theString)
      Sets the value for version (id.version)

      Definition: 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 ca.uhn.fhir.model.primitive.StringDt getNameElement()
      Gets the value(s) for name (). creating it if it does not exist. Will not return null.

      Definition: A free text natural language name identifying the StructureDefinition

    • getName

      public String getName()
      Gets the value(s) for name (). creating it if it does not exist. This method may return null.

      Definition: A free text natural language name identifying the StructureDefinition

    • setName

      public StructureDefinition setName(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for name ()

      Definition: A free text natural language name identifying the StructureDefinition

    • setName

      public StructureDefinition setName(String theString)
      Sets the value for name ()

      Definition: A free text natural language name identifying the StructureDefinition

    • getDisplayElement

      public ca.uhn.fhir.model.primitive.StringDt getDisplayElement()
      Gets the value(s) for display (). creating it if it does not exist. Will not return null.

      Definition: Defined so that applications can use this name when displaying the value of the extension to the user

    • getDisplay

      public String getDisplay()
      Gets the value(s) for display (). creating it if it does not exist. This method may return null.

      Definition: Defined so that applications can use this name when displaying the value of the extension to the user

    • setDisplay

      public StructureDefinition setDisplay(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for display ()

      Definition: Defined so that applications can use this name when displaying the value of the extension to the user

    • setDisplay

      public StructureDefinition setDisplay(String theString)
      Sets the value for display ()

      Definition: Defined so that applications can use this name when displaying the value of the extension to the user

    • getStatusElement

      public ca.uhn.fhir.model.primitive.BoundCodeDt<ConformanceResourceStatusEnum> getStatusElement()
      Gets the value(s) for status (status). creating it if it does not exist. Will not return null.

      Definition: The status of the StructureDefinition

    • getStatus

      public String getStatus()
      Gets the value(s) for status (status). creating it if it does not exist. This method may return null.

      Definition: The status of the StructureDefinition

    • setStatus

      public StructureDefinition setStatus(ca.uhn.fhir.model.primitive.BoundCodeDt<ConformanceResourceStatusEnum> theValue)
      Sets the value(s) for status (status)

      Definition: The status of the StructureDefinition

    • setStatus

      Sets the value(s) for status (status)

      Definition: The status of the StructureDefinition

    • getExperimentalElement

      public ca.uhn.fhir.model.primitive.BooleanDt getExperimentalElement()
      Gets the value(s) for experimental (class). creating it if it does not exist. Will not return null.

      Definition: This StructureDefinition was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage

    • getExperimental

      Gets the value(s) for experimental (class). creating it if it does not exist. This method may return null.

      Definition: 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(ca.uhn.fhir.model.primitive.BooleanDt theValue)
      Sets the value(s) for experimental (class)

      Definition: 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 theBoolean)
      Sets the value for experimental (class)

      Definition: This StructureDefinition was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage

    • getPublisherElement

      public ca.uhn.fhir.model.primitive.StringDt getPublisherElement()
      Gets the value(s) for publisher (who.witness). creating it if it does not exist. Will not return null.

      Definition: The name of the individual or organization that published the structure definition

    • getPublisher

      public String getPublisher()
      Gets the value(s) for publisher (who.witness). creating it if it does not exist. This method may return null.

      Definition: The name of the individual or organization that published the structure definition

    • setPublisher

      public StructureDefinition setPublisher(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for publisher (who.witness)

      Definition: The name of the individual or organization that published the structure definition

    • setPublisher

      public StructureDefinition setPublisher(String theString)
      Sets the value for publisher (who.witness)

      Definition: The name of the individual or organization that published the structure definition

    • getContact

      Gets the value(s) for contact (). creating it if it does not exist. Will not return null.

      Definition: Contacts to assist a user in finding and communicating with the publisher

    • setContact

      Sets the value(s) for contact ()

      Definition: Contacts to assist a user in finding and communicating with the publisher

    • addContact

      Adds and returns a new value for contact ()

      Definition: Contacts to assist a user in finding and communicating with the publisher

    • addContact

      Adds a given new value for contact ()

      Definition: Contacts to assist a user in finding and communicating with the publisher

      Parameters:
      theValue - The contact to add (must not be null)
    • getContactFirstRep

      Gets the first repetition for contact (), creating it if it does not already exist.

      Definition: Contacts to assist a user in finding and communicating with the publisher

    • getDateElement

      public ca.uhn.fhir.model.primitive.DateTimeDt getDateElement()
      Gets the value(s) for date (when.recorded). creating it if it does not exist. Will not return null.

      Definition: 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

    • getDate

      public Date getDate()
      Gets the value(s) for date (when.recorded). creating it if it does not exist. This method may return null.

      Definition: 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(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
      Sets the value(s) for date (when.recorded)

      Definition: 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 theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
      Sets the value for date (when.recorded)

      Definition: 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

    • setDateWithSecondsPrecision

      Sets the value for date (when.recorded)

      Definition: 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 ca.uhn.fhir.model.primitive.StringDt getDescriptionElement()
      Gets the value(s) for description (). creating it if it does not exist. Will not return null.

      Definition: A free text natural language description of the StructureDefinition and its use

    • getDescription

      Gets the value(s) for description (). creating it if it does not exist. This method may return null.

      Definition: A free text natural language description of the StructureDefinition and its use

    • setDescription

      public StructureDefinition setDescription(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for description ()

      Definition: A free text natural language description of the StructureDefinition and its use

    • setDescription

      public StructureDefinition setDescription(String theString)
      Sets the value for description ()

      Definition: A free text natural language description of the StructureDefinition and its use

    • getUseContext

      Gets the value(s) for useContext (). creating it if it does not exist. Will not return null.

      Definition: 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.

    • setUseContext

      Sets the value(s) for useContext ()

      Definition: 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

      Adds and returns a new value for useContext ()

      Definition: 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

      Adds a given new value for useContext ()

      Definition: 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.

      Parameters:
      theValue - The useContext to add (must not be null)
    • getUseContextFirstRep

      Gets the first repetition for useContext (), creating it if it does not already exist.

      Definition: 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 ca.uhn.fhir.model.primitive.StringDt getRequirementsElement()
      Gets the value(s) for requirements (why). creating it if it does not exist. Will not return null.

      Definition: Explains why this structure definition is needed and why it's been constrained as it has

    • getRequirements

      Gets the value(s) for requirements (why). creating it if it does not exist. This method may return null.

      Definition: Explains why this structure definition is needed and why it's been constrained as it has

    • setRequirements

      public StructureDefinition setRequirements(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for requirements (why)

      Definition: Explains why this structure definition is needed and why it's been constrained as it has

    • setRequirements

      Sets the value for requirements (why)

      Definition: Explains why this structure definition is needed and why it's been constrained as it has

    • getCopyrightElement

      public ca.uhn.fhir.model.primitive.StringDt getCopyrightElement()
      Gets the value(s) for copyright (). creating it if it does not exist. Will not return null.

      Definition: 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

    • getCopyright

      public String getCopyright()
      Gets the value(s) for copyright (). creating it if it does not exist. This method may return null.

      Definition: 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(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for copyright ()

      Definition: 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 theString)
      Sets the value for copyright ()

      Definition: 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<CodingDt> getCode()
      Gets the value(s) for code (). creating it if it does not exist. Will not return null.

      Definition: A set of terms from external terminologies that may be used to assist with indexing and searching of templates.

    • setCode

      public StructureDefinition setCode(List<CodingDt> theValue)
      Sets the value(s) for code ()

      Definition: A set of terms from external terminologies that may be used to assist with indexing and searching of templates.

    • addCode

      public CodingDt addCode()
      Adds and returns a new value for code ()

      Definition: A set of terms from external terminologies that may be used to assist with indexing and searching of templates.

    • addCode

      public StructureDefinition addCode(CodingDt theValue)
      Adds a given new value for code ()

      Definition: A set of terms from external terminologies that may be used to assist with indexing and searching of templates.

      Parameters:
      theValue - The code to add (must not be null)
    • getCodeFirstRep

      Gets the first repetition for code (), creating it if it does not already exist.

      Definition: A set of terms from external terminologies that may be used to assist with indexing and searching of templates.

    • getFhirVersionElement

      public ca.uhn.fhir.model.primitive.IdDt getFhirVersionElement()
      Gets the value(s) for fhirVersion (). creating it if it does not exist. Will not return null.

      Definition: 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 $version$ for this version

    • getFhirVersion

      Gets the value(s) for fhirVersion (). creating it if it does not exist. This method may return null.

      Definition: 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 $version$ for this version

    • setFhirVersion

      public StructureDefinition setFhirVersion(ca.uhn.fhir.model.primitive.IdDt theValue)
      Sets the value(s) for fhirVersion ()

      Definition: 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 $version$ for this version

    • setFhirVersion

      Sets the value for fhirVersion ()

      Definition: 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 $version$ for this version

    • getMapping

      Gets the value(s) for mapping (). creating it if it does not exist. Will not return null.

      Definition: An external specification that the content is mapped to

    • setMapping

      Sets the value(s) for mapping ()

      Definition: An external specification that the content is mapped to

    • addMapping

      Adds and returns a new value for mapping ()

      Definition: An external specification that the content is mapped to

    • addMapping

      Adds a given new value for mapping ()

      Definition: An external specification that the content is mapped to

      Parameters:
      theValue - The mapping to add (must not be null)
    • getMappingFirstRep

      Gets the first repetition for mapping (), creating it if it does not already exist.

      Definition: An external specification that the content is mapped to

    • getKindElement

      public ca.uhn.fhir.model.primitive.BoundCodeDt<StructureDefinitionKindEnum> getKindElement()
      Gets the value(s) for kind (). creating it if it does not exist. Will not return null.

      Definition: Defines the kind of structure that this definition is describing

    • getKind

      public String getKind()
      Gets the value(s) for kind (). creating it if it does not exist. This method may return null.

      Definition: Defines the kind of structure that this definition is describing

    • setKind

      public StructureDefinition setKind(ca.uhn.fhir.model.primitive.BoundCodeDt<StructureDefinitionKindEnum> theValue)
      Sets the value(s) for kind ()

      Definition: Defines the kind of structure that this definition is describing

    • setKind

      Sets the value(s) for kind ()

      Definition: Defines the kind of structure that this definition is describing

    • getConstrainedTypeElement

      public ca.uhn.fhir.model.primitive.CodeDt getConstrainedTypeElement()
      Gets the value(s) for constrainedType (). creating it if it does not exist. Will not return null.

      Definition: 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

    • getConstrainedType

      Gets the value(s) for constrainedType (). creating it if it does not exist. This method may return null.

      Definition: 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(ca.uhn.fhir.model.primitive.CodeDt theValue)
      Sets the value(s) for constrainedType ()

      Definition: 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

      Sets the value for constrainedType ()

      Definition: 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 ca.uhn.fhir.model.primitive.BooleanDt getAbstractElement()
      Gets the value(s) for abstract (). creating it if it does not exist. Will not return null.

      Definition: Whether structure this definition describes is abstract or not - that is, whether an actual exchanged item can ever be of this type

    • getAbstract

      public Boolean getAbstract()
      Gets the value(s) for abstract (). creating it if it does not exist. This method may return null.

      Definition: 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(ca.uhn.fhir.model.primitive.BooleanDt theValue)
      Sets the value(s) for abstract ()

      Definition: 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 theBoolean)
      Sets the value for abstract ()

      Definition: Whether structure this definition describes is abstract or not - that is, whether an actual exchanged item can ever be of this type

    • getContextTypeElement

      public ca.uhn.fhir.model.primitive.BoundCodeDt<ExtensionContextEnum> getContextTypeElement()
      Gets the value(s) for contextType (). creating it if it does not exist. Will not return null.

      Definition: If this is an extension, Identifies the context within FHIR resources where the extension can be used

    • getContextType

      Gets the value(s) for contextType (). creating it if it does not exist. This method may return null.

      Definition: If this is an extension, Identifies the context within FHIR resources where the extension can be used

    • setContextType

      public StructureDefinition setContextType(ca.uhn.fhir.model.primitive.BoundCodeDt<ExtensionContextEnum> theValue)
      Sets the value(s) for contextType ()

      Definition: If this is an extension, Identifies the context within FHIR resources where the extension can be used

    • setContextType

      Sets the value(s) for contextType ()

      Definition: If this is an extension, Identifies the context within FHIR resources where the extension can be used

    • getContext

      public List<ca.uhn.fhir.model.primitive.StringDt> getContext()
      Gets the value(s) for context (). creating it if it does not exist. Will not return null.

      Definition: Identifies the types of resource or data type elements to which the extension can be applied

    • setContext

      public StructureDefinition setContext(List<ca.uhn.fhir.model.primitive.StringDt> theValue)
      Sets the value(s) for context ()

      Definition: Identifies the types of resource or data type elements to which the extension can be applied

    • addContext

      public ca.uhn.fhir.model.primitive.StringDt addContext()
      Adds and returns a new value for context ()

      Definition: Identifies the types of resource or data type elements to which the extension can be applied

    • addContext

      public StructureDefinition addContext(ca.uhn.fhir.model.primitive.StringDt theValue)
      Adds a given new value for context ()

      Definition: Identifies the types of resource or data type elements to which the extension can be applied

      Parameters:
      theValue - The context to add (must not be null)
    • getContextFirstRep

      public ca.uhn.fhir.model.primitive.StringDt getContextFirstRep()
      Gets the first repetition for context (), creating it if it does not already exist.

      Definition: Identifies the types of resource or data type elements to which the extension can be applied

    • addContext

      public StructureDefinition addContext(String theString)
      Adds a new value for context ()

      Definition: Identifies the types of resource or data type elements to which the extension can be applied

      Returns:
      Returns a reference to this object, to allow for simple chaining.
    • getBaseElement

      public ca.uhn.fhir.model.primitive.UriDt getBaseElement()
      Gets the value(s) for base (). creating it if it does not exist. Will not return null.

      Definition: An absolute URI that is the base structure from which this set of constraints is derived

    • getBase

      public String getBase()
      Gets the value(s) for base (). creating it if it does not exist. This method may return null.

      Definition: An absolute URI that is the base structure from which this set of constraints is derived

    • setBase

      public StructureDefinition setBase(ca.uhn.fhir.model.primitive.UriDt theValue)
      Sets the value(s) for base ()

      Definition: An absolute URI that is the base structure from which this set of constraints is derived

    • setBase

      public StructureDefinition setBase(String theUri)
      Sets the value for base ()

      Definition: An absolute URI that is the base structure from which this set of constraints is derived

    • getSnapshot

      Gets the value(s) for snapshot (). creating it if it does not exist. Will not return null.

      Definition: A snapshot view is expressed in a stand alone form that can be used and interpreted without considering the base StructureDefinition

    • setSnapshot

      Sets the value(s) for snapshot ()

      Definition: A snapshot view is expressed in a stand alone form that can be used and interpreted without considering the base StructureDefinition

    • getDifferential

      Gets the value(s) for differential (). creating it if it does not exist. Will not return null.

      Definition: A differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies

    • setDifferential

      Sets the value(s) for differential ()

      Definition: A differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies

    • getResourceName

      Specified by:
      getResourceName in interface ca.uhn.fhir.model.api.IResource
    • getStructureFhirVersionEnum

      public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
      Specified by:
      getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
      Specified by:
      getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource