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

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 Details

    • identifier

      A formal identifier that is used to identify this structure definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
    • purpose

      protected MarkdownType purpose
      Explaination of why this structure definition is needed and why it has been designed as it has.
    • keyword

      protected List<Coding> keyword
      A set of key words or 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 3.0.2 for this version.
    • mapping

      An external specification that the content is mapped to.
    • kind

      Defines the kind of structure that this definition is describing.
    • abstract_

      Whether structure this definition describes is abstract or not - that is, whether the structure is not intended to be instantiated. For Resources and Data types, abstract types will never be exchanged between systems.
    • contextType

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

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

      A set of rules as Fluent Invariants about when the extension can be used (e.g. co-occurrence variants for the extension).
    • type

      protected CodeType type
      The type this structure describes. If the derivation kind is 'specialization' then this is the master definition for a type, and there is always one of these (a data type, an extension, a resource, including abstract ones). Otherwise the structure definition is a constraint on the stated type (and in this case, the type cannot be an abstract type).
    • baseDefinition

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

      How the type relates to the baseDefinition.
    • snapshot

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

      A differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.
    • SP_DATE

      public static final String SP_DATE
      Search parameter: date

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

    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: identifier

      Description: External identifier for the structure definition
      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: External identifier for the structure definition
      Type: token
      Path: StructureDefinition.identifier

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

      public static final String SP_KIND
      Search parameter: kind

      Description: primitive-type | complex-type | 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: primitive-type | complex-type | resource | logical
      Type: token
      Path: StructureDefinition.kind

    • SP_JURISDICTION

      public static final String SP_JURISDICTION
      Search parameter: jurisdiction

      Description: Intended jurisdiction for the structure definition
      Type: token
      Path: StructureDefinition.jurisdiction

      See Also:
      Constant Field Values
    • JURISDICTION

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

      Description: Intended jurisdiction for the structure definition
      Type: token
      Path: StructureDefinition.jurisdiction

    • SP_DESCRIPTION

      public static final String SP_DESCRIPTION
      Search parameter: description

      Description: The description of the structure definition
      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: The description of the structure definition
      Type: string
      Path: StructureDefinition.description

    • SP_EXPERIMENTAL

      public static final String SP_EXPERIMENTAL
      Search parameter: experimental

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

    • 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_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_TITLE

      public static final String SP_TITLE
      Search parameter: title

      Description: The human-friendly name of the structure definition
      Type: string
      Path: StructureDefinition.title

      See Also:
      Constant Field Values
    • TITLE

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

      Description: The human-friendly name of the structure definition
      Type: string
      Path: StructureDefinition.title

    • SP_TYPE

      public static final String SP_TYPE
      Search parameter: type

      Description: Type defined or constrained by this structure
      Type: token
      Path: StructureDefinition.type

      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 defined or constrained by this structure
      Type: token
      Path: StructureDefinition.type

    • SP_VERSION

      public static final String SP_VERSION
      Search parameter: version

      Description: The business version of the structure definition
      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 business version of the structure definition
      Type: token
      Path: StructureDefinition.version

    • SP_URL

      public static final String SP_URL
      Search parameter: url

      Description: The uri that identifies the structure definition
      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: The uri that identifies the structure definition
      Type: uri
      Path: StructureDefinition.url

    • 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_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_NAME

      public static final String SP_NAME
      Search parameter: name

      Description: Computationally friendly name of the structure definition
      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: Computationally friendly name of the structure definition
      Type: string
      Path: StructureDefinition.name

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

      public static final String SP_PUBLISHER
      Search parameter: publisher

      Description: Name of the publisher of the structure definition
      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 structure definition
      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_KEYWORD

      public static final String SP_KEYWORD
      Search parameter: keyword

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

      See Also:
      Constant Field Values
    • KEYWORD

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

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

    • SP_STATUS

      public static final String SP_STATUS
      Search parameter: status

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

    • 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

  • Constructor Details

  • Method Details