Package org.hl7.fhir.dstu2.model

Class StructureDefinition

java.lang.Object
org.hl7.fhir.dstu2.model.Base
org.hl7.fhir.dstu2.model.BaseResource
org.hl7.fhir.dstu2.model.Resource
org.hl7.fhir.dstu2.model.DomainResource
org.hl7.fhir.dstu2.model.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:

  • Field Details

  • Constructor Details

  • Method Details

    • 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

    • hasUrlElement

      public boolean hasUrlElement()

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

    • hasIdentifier

      public boolean hasIdentifier()

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

    • addIdentifier

      public StructureDefinition addIdentifier(Identifier t)

    • 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

    • hasVersionElement

      public boolean hasVersionElement()

    • hasVersion

      public boolean hasVersion()

    • 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

    • hasNameElement

      public boolean hasNameElement()

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

    • setName

      public StructureDefinition setName(String value)
      Parameters:
      value - 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

    • hasDisplayElement

      public boolean hasDisplayElement()

    • hasDisplay

      public boolean hasDisplay()

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

    • getStatusElement

      public Enumeration<Enumerations.ConformanceResourceStatus> getStatusElement()
      Returns:
      status (The status of the StructureDefinition.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

    • hasStatusElement

      public boolean hasStatusElement()

    • hasStatus

      public boolean hasStatus()

    • setStatusElement

      public StructureDefinition setStatusElement(Enumeration<Enumerations.ConformanceResourceStatus> value)
      Parameters:
      value - status (The status of the StructureDefinition.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

    • getStatus

      public Enumerations.ConformanceResourceStatus getStatus()
      Returns:
      The status of the StructureDefinition.

    • setStatus

      public StructureDefinition setStatus(Enumerations.ConformanceResourceStatus value)
      Parameters:
      value - The status of the StructureDefinition.

    • 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

    • hasExperimentalElement

      public boolean hasExperimentalElement()

    • hasExperimental

      public boolean hasExperimental()

    • 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

    • hasPublisherElement

      public boolean hasPublisherElement()

    • hasPublisher

      public boolean hasPublisher()

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

    • setPublisher

      public StructureDefinition setPublisher(String value)
      Parameters:
      value - The name of the individual or organization that published the structure definition.

    • getContact

      public List<StructureDefinition.StructureDefinitionContactComponent> getContact()
      Returns:
      contact (Contacts to assist a user in finding and communicating with the publisher.)

    • hasContact

      public boolean hasContact()

    • addContact

      public StructureDefinition.StructureDefinitionContactComponent addContact()
      Returns:
      contact (Contacts to assist a user in finding and communicating with the publisher.)

    • addContact

      public StructureDefinition addContact(StructureDefinition.StructureDefinitionContactComponent t)

    • 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

    • hasDateElement

      public boolean hasDateElement()

    • 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

    • hasDescriptionElement

      public boolean hasDescriptionElement()

    • hasDescription

      public boolean hasDescription()

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

    • setDescription

      public StructureDefinition setDescription(String value)
      Parameters:
      value - 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.)

    • hasUseContext

      public boolean hasUseContext()

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

    • addUseContext

      public StructureDefinition addUseContext(CodeableConcept t)

    • 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

    • hasRequirementsElement

      public boolean hasRequirementsElement()

    • hasRequirements

      public boolean hasRequirements()

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

    • setRequirements

      public StructureDefinition setRequirements(String value)
      Parameters:
      value - 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

    • hasCopyrightElement

      public boolean hasCopyrightElement()

    • hasCopyright

      public boolean hasCopyright()

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

    • addCode

      public StructureDefinition addCode(Coding t)

    • 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

    • hasFhirVersionElement

      public boolean hasFhirVersionElement()

    • hasFhirVersion

      public boolean hasFhirVersion()

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

    • getMapping

      public List<StructureDefinition.StructureDefinitionMappingComponent> getMapping()
      Returns:
      mapping (An external specification that the content is mapped to.)

    • hasMapping

      public boolean hasMapping()

    • addMapping

      public StructureDefinition.StructureDefinitionMappingComponent addMapping()
      Returns:
      mapping (An external specification that the content is mapped to.)

    • addMapping

      public StructureDefinition addMapping(StructureDefinition.StructureDefinitionMappingComponent t)

    • getKindElement

      public Enumeration<StructureDefinition.StructureDefinitionKind> getKindElement()
      Returns:
      kind (Defines the kind of structure that this definition is describing.). This is the underlying object with id, value and extensions. The accessor "getKind" gives direct access to the value

    • hasKindElement

      public boolean hasKindElement()

    • hasKind

      public boolean hasKind()

    • setKindElement

      public StructureDefinition setKindElement(Enumeration<StructureDefinition.StructureDefinitionKind> value)
      Parameters:
      value - kind (Defines the kind of structure that this definition is describing.). This is the underlying object with id, value and extensions. The accessor "getKind" gives direct access to the value

    • getKind

      public StructureDefinition.StructureDefinitionKind getKind()
      Returns:
      Defines the kind of structure that this definition is describing.

    • setKind

      public StructureDefinition setKind(StructureDefinition.StructureDefinitionKind value)
      Parameters:
      value - Defines the kind of structure that this definition is describing.

    • 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

    • hasConstrainedTypeElement

      public boolean hasConstrainedTypeElement()

    • hasConstrainedType

      public boolean hasConstrainedType()

    • 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

    • hasAbstractElement

      public boolean hasAbstractElement()

    • hasAbstract

      public boolean hasAbstract()

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

    • getContextTypeElement

      public Enumeration<StructureDefinition.ExtensionContext> getContextTypeElement()
      Returns:
      contextType (If this is an extension, Identifies the context within FHIR resources where the extension can be used.). This is the underlying object with id, value and extensions. The accessor "getContextType" gives direct access to the value

    • hasContextTypeElement

      public boolean hasContextTypeElement()

    • hasContextType

      public boolean hasContextType()

    • setContextTypeElement

      public StructureDefinition setContextTypeElement(Enumeration<StructureDefinition.ExtensionContext> value)
      Parameters:
      value - contextType (If this is an extension, Identifies the context within FHIR resources where the extension can be used.). This is the underlying object with id, value and extensions. The accessor "getContextType" gives direct access to the value

    • getContextType

      public StructureDefinition.ExtensionContext getContextType()
      Returns:
      If this is an extension, Identifies the context within FHIR resources where the extension can be used.

    • setContextType

      public StructureDefinition setContextType(StructureDefinition.ExtensionContext value)
      Parameters:
      value - If this is an extension, Identifies the context within FHIR resources where the extension can be used.

    • getContext

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

    • hasContext

      public boolean hasContext()

    • addContextElement

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

    • addContext

      public StructureDefinition addContext(String value)
      Parameters:
      value - 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

    • hasBaseElement

      public boolean hasBaseElement()

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

    • getSnapshot

      public StructureDefinition.StructureDefinitionSnapshotComponent getSnapshot()
      Returns:
      snapshot (A snapshot view is expressed in a stand alone form that can be used and interpreted without considering the base StructureDefinition.)

    • hasSnapshot

      public boolean hasSnapshot()

    • setSnapshot

      public StructureDefinition setSnapshot(StructureDefinition.StructureDefinitionSnapshotComponent value)
      Parameters:
      value - snapshot (A snapshot view is expressed in a stand alone form that can be used and interpreted without considering the base StructureDefinition.)

    • getDifferential

      public StructureDefinition.StructureDefinitionDifferentialComponent getDifferential()
      Returns:
      differential (A differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.)

    • hasDifferential

      public boolean hasDifferential()

    • setDifferential

      public StructureDefinition setDifferential(StructureDefinition.StructureDefinitionDifferentialComponent value)
      Parameters:
      value - differential (A differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.)

    • listChildren

      protected void listChildren(List<Property> childrenList)
      Overrides:
      listChildren in class DomainResource

    • setProperty

      public void setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • addChild

      public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      addChild in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • fhirType

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

    • copy

      public StructureDefinition copy()
      Specified by:
      copy in class DomainResource

    • typedCopy

      protected StructureDefinition typedCopy()

    • equalsDeep

      public boolean equalsDeep(Base other)
      Overrides:
      equalsDeep in class DomainResource

    • equalsShallow

      public boolean equalsShallow(Base other)
      Overrides:
      equalsShallow in class DomainResource

    • isEmpty

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

    • getResourceType

      public ResourceType getResourceType()
      Specified by:
      getResourceType in class Resource