Class Citation

  • 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 Citation
    extends DomainResource
    The Citation Resource enables reference to any knowledge artifact for purposes of identification and attribution. The Citation Resource supports existing reference structures and developing publication practices such as versioning, expressing complex contributorship roles, and referencing computable resources.
    See Also:
    Serialized Form
    • Field Detail

      • url

        protected UriType url
        An absolute URI that is used to identify this citation when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this summary is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the summary is stored on different servers.
      • identifier

        protected List<Identifier> identifier
        A formal identifier that is used to identify this citation when it is represented in other formats, or referenced in a specification, model, design or an instance.
      • version

        protected StringType version
        The identifier that is used to identify this version of the citation when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the citation author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
      • name

        protected StringType name
        A natural language name identifying the citation. This name should be usable as an identifier for the module by machine processing applications such as code generation.
      • title

        protected StringType title
        A short, descriptive, user-friendly title for the citation.
      • experimental

        protected BooleanType experimental
        A Boolean value to indicate that this citation is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
      • date

        protected DateTimeType date
        The date (and optionally time) when the citation was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the citation changes.
      • publisher

        protected StringType publisher
        The name of the organization or individual that published the citation.
      • contact

        protected List<ContactDetail> contact
        Contact details to assist a user in finding and communicating with the publisher.
      • description

        protected MarkdownType description
        A free text natural language description of the citation from a consumer's perspective.
      • useContext

        protected List<UsageContext> useContext
        The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate citation instances.
      • purpose

        protected MarkdownType purpose
        Explanation of why this citation is needed and why it has been designed as it has.
      • copyright

        protected MarkdownType copyright
        Use and/or publishing restrictions for the Citation, not for the cited artifact.
      • approvalDate

        protected DateType approvalDate
        The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
      • lastReviewDate

        protected DateType lastReviewDate
        The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
      • effectivePeriod

        protected Period effectivePeriod
        The period during which the citation content was or is planned to be in active use.
      • note

        protected List<Annotation> note
        Used for general notes and annotations not coded elsewhere.
      • SP_CONTEXT_QUANTITY

        public static final String SP_CONTEXT_QUANTITY
        Search parameter: context-quantity

        Description: A quantity- or range-valued use context assigned to the citation
        Type: quantity
        Path: (Citation.useContext.value as Quantity) | (Citation.useContext.value as Range)

        See Also:
        Constant Field Values
      • CONTEXT_QUANTITY

        public static final ca.uhn.fhir.rest.gclient.QuantityClientParam CONTEXT_QUANTITY
        Fluent Client search parameter constant for context-quantity

        Description: A quantity- or range-valued use context assigned to the citation
        Type: quantity
        Path: (Citation.useContext.value as Quantity) | (Citation.useContext.value as Range)

      • SP_CONTEXT_TYPE_QUANTITY

        public static final String SP_CONTEXT_TYPE_QUANTITY
        Search parameter: context-type-quantity

        Description: A use context type and quantity- or range-based value assigned to the citation
        Type: composite
        Path: Citation.useContext

        See Also:
        Constant Field Values
      • CONTEXT_TYPE_QUANTITY

        public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,​ca.uhn.fhir.rest.gclient.QuantityClientParam> CONTEXT_TYPE_QUANTITY
        Fluent Client search parameter constant for context-type-quantity

        Description: A use context type and quantity- or range-based value assigned to the citation
        Type: composite
        Path: Citation.useContext

      • SP_CONTEXT_TYPE_VALUE

        public static final String SP_CONTEXT_TYPE_VALUE
        Search parameter: context-type-value

        Description: A use context type and value assigned to the citation
        Type: composite
        Path: Citation.useContext

        See Also:
        Constant Field Values
      • CONTEXT_TYPE_VALUE

        public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,​ca.uhn.fhir.rest.gclient.TokenClientParam> CONTEXT_TYPE_VALUE
        Fluent Client search parameter constant for context-type-value

        Description: A use context type and value assigned to the citation
        Type: composite
        Path: Citation.useContext

      • SP_CONTEXT_TYPE

        public static final String SP_CONTEXT_TYPE
        Search parameter: context-type

        Description: A type of use context assigned to the citation
        Type: token
        Path: Citation.useContext.code

        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: A type of use context assigned to the citation
        Type: token
        Path: Citation.useContext.code

      • SP_CONTEXT

        public static final String SP_CONTEXT
        Search parameter: context

        Description: A use context assigned to the citation
        Type: token
        Path: (Citation.useContext.value as CodeableConcept)

        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 citation
        Type: token
        Path: (Citation.useContext.value as CodeableConcept)

      • SP_DATE

        public static final String SP_DATE
        Search parameter: date

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

      • SP_DESCRIPTION

        public static final String SP_DESCRIPTION
        Search parameter: description

        Description: The description of the citation
        Type: string
        Path: Citation.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 citation
        Type: string
        Path: Citation.description

      • SP_EFFECTIVE

        public static final String SP_EFFECTIVE
        Search parameter: effective

        Description: The time during which the citation is intended to be in use
        Type: date
        Path: Citation.effectivePeriod

        See Also:
        Constant Field Values
      • EFFECTIVE

        public static final ca.uhn.fhir.rest.gclient.DateClientParam EFFECTIVE
        Fluent Client search parameter constant for effective

        Description: The time during which the citation is intended to be in use
        Type: date
        Path: Citation.effectivePeriod

      • SP_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter: identifier

        Description: External identifier for the citation
        Type: token
        Path: Citation.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 citation
        Type: token
        Path: Citation.identifier

      • SP_JURISDICTION

        public static final String SP_JURISDICTION
        Search parameter: jurisdiction

        Description: Intended jurisdiction for the citation
        Type: token
        Path: Citation.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 citation
        Type: token
        Path: Citation.jurisdiction

      • SP_NAME

        public static final String SP_NAME
        Search parameter: name

        Description: Computationally friendly name of the citation
        Type: string
        Path: Citation.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 citation
        Type: string
        Path: Citation.name

      • SP_PUBLISHER

        public static final String SP_PUBLISHER
        Search parameter: publisher

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

      • SP_STATUS

        public static final String SP_STATUS
        Search parameter: status

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

      • SP_TITLE

        public static final String SP_TITLE
        Search parameter: title

        Description: The human-friendly name of the citation
        Type: string
        Path: Citation.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 citation
        Type: string
        Path: Citation.title

      • SP_URL

        public static final String SP_URL
        Search parameter: url

        Description: The uri that identifies the citation
        Type: uri
        Path: Citation.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 citation
        Type: uri
        Path: Citation.url

      • SP_VERSION

        public static final String SP_VERSION
        Search parameter: version

        Description: The business version of the citation
        Type: token
        Path: Citation.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 citation
        Type: token
        Path: Citation.version