Class CompartmentDefinition

  • 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 CompartmentDefinition
    extends DomainResource
    A compartment definition that defines how resources are accessed on a server.
    See Also:
    Serialized Form
    • Field Detail

      • url

        protected UriType url
        An absolute URL that is used to identify this compartment 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 compartment definition is (or will be) published.
      • name

        protected StringType name
        A free text natural language name identifying the compartment definition.
      • experimental

        protected BooleanType experimental
        A flag to indicate that this compartment definition definition is 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 compartment definition.
      • date

        protected DateTimeType date
        The date (and optionally time) when the compartment definition 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 compartment definition changes.
      • description

        protected StringType description
        A free text natural language description of the CompartmentDefinition and its use.
      • requirements

        protected StringType requirements
        The Scope and Usage that this compartment definition was created to meet.
      • SP_STATUS

        public static final String SP_STATUS
        Search parameter: status

        Description: draft | active | retired
        Type: token
        Path: CompartmentDefinition.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: draft | active | retired
        Type: token
        Path: CompartmentDefinition.status

      • SP_NAME

        public static final String SP_NAME
        Search parameter: name

        Description: Informal name for this compartment definition
        Type: string
        Path: CompartmentDefinition.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: Informal name for this compartment definition
        Type: string
        Path: CompartmentDefinition.name

      • SP_RESOURCE

        public static final String SP_RESOURCE
        Search parameter: resource

        Description: Name of resource type
        Type: token
        Path: CompartmentDefinition.resource.code

        See Also:
        Constant Field Values
      • RESOURCE

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

        Description: Name of resource type
        Type: token
        Path: CompartmentDefinition.resource.code

      • SP_CODE

        public static final String SP_CODE
        Search parameter: code

        Description: Patient | Encounter | RelatedPerson | Practitioner | Device
        Type: token
        Path: CompartmentDefinition.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: Patient | Encounter | RelatedPerson | Practitioner | Device
        Type: token
        Path: CompartmentDefinition.code

      • SP_DATE

        public static final String SP_DATE
        Search parameter: date

        Description: Publication Date(/time)
        Type: date
        Path: CompartmentDefinition.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: Publication Date(/time)
        Type: date
        Path: CompartmentDefinition.date

      • SP_URL

        public static final String SP_URL
        Search parameter: url

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