Class Composition

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 Composition extends DomainResource
A set of healthcare-related information that is assembled together into a single logical document that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. While a Composition defines the structure, it does not actually contain the content: rather the full content of a document is contained in a Bundle, of which the Composition is the first resource contained.
See Also:
Serialized Form
  • Field Details

    • identifier

      Logical identifier for the composition, assigned when created. This identifier stays constant as the composition is changed over time.
    • status

      The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.
    • type

      protected CodeableConcept type
      Specifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition.
    • class_

      A categorization for the type of the composition - helps for indexing and searching. This may be implied by or derived from the code specified in the Composition Type.
    • subject

      protected Reference subject
      Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure).
    • subjectTarget

      The actual object that is the target of the reference (Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure).)
    • encounter

      protected Reference encounter
      Describes the clinical encounter or type of care this documentation is associated with.
    • encounterTarget

      The actual object that is the target of the reference (Describes the clinical encounter or type of care this documentation is associated with.)
    • date

      protected DateTimeType date
      The composition editing time, when the composition was last logically changed by the author.
    • author

      protected List<Reference> author
      Identifies who is responsible for the information in the composition, not necessarily who typed it in.
    • authorTarget

      The actual objects that are the target of the reference (Identifies who is responsible for the information in the composition, not necessarily who typed it in.)
    • title

      protected StringType title
      Official human-readable label for the composition.
    • confidentiality

      The code specifying the level of confidentiality of the Composition.
    • attester

      A participant who has attested to the accuracy of the composition/document.
    • custodian

      protected Reference custodian
      Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.
    • custodianTarget

      The actual object that is the target of the reference (Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.)
    • relatesTo

      Relationships that this composition has with other compositions or documents that already exist.
    • event

      The clinical service, such as a colonoscopy or an appendectomy, being documented.
    • section

      The root of the sections that make up the composition.
    • SP_DATE

      public static final String SP_DATE
      Search parameter: date

      Description: Composition editing time
      Type: date
      Path: Composition.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: Composition editing time
      Type: date
      Path: Composition.date

    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: identifier

      Description: Logical identifier of composition (version-independent)
      Type: token
      Path: Composition.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: Logical identifier of composition (version-independent)
      Type: token
      Path: Composition.identifier

    • SP_PERIOD

      public static final String SP_PERIOD
      Search parameter: period

      Description: The period covered by the documentation
      Type: date
      Path: Composition.event.period

      See Also:
      Constant Field Values
    • PERIOD

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

      Description: The period covered by the documentation
      Type: date
      Path: Composition.event.period

    • SP_SUBJECT

      public static final String SP_SUBJECT
      Search parameter: subject

      Description: Who and/or what the composition is about
      Type: reference
      Path: Composition.subject

      See Also:
      Constant Field Values
    • SUBJECT

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT
      Fluent Client search parameter constant for subject

      Description: Who and/or what the composition is about
      Type: reference
      Path: Composition.subject

    • INCLUDE_SUBJECT

      public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Composition:subject".
    • SP_AUTHOR

      public static final String SP_AUTHOR
      Search parameter: author

      Description: Who and/or what authored the composition
      Type: reference
      Path: Composition.author

      See Also:
      Constant Field Values
    • AUTHOR

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam AUTHOR
      Fluent Client search parameter constant for author

      Description: Who and/or what authored the composition
      Type: reference
      Path: Composition.author

    • INCLUDE_AUTHOR

      public static final ca.uhn.fhir.model.api.Include INCLUDE_AUTHOR
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Composition:author".
    • SP_CONFIDENTIALITY

      public static final String SP_CONFIDENTIALITY
      Search parameter: confidentiality

      Description: As defined by affinity domain
      Type: token
      Path: Composition.confidentiality

      See Also:
      Constant Field Values
    • CONFIDENTIALITY

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

      Description: As defined by affinity domain
      Type: token
      Path: Composition.confidentiality

    • SP_SECTION

      public static final String SP_SECTION
      Search parameter: section

      Description: Classification of section (recommended)
      Type: token
      Path: Composition.section.code

      See Also:
      Constant Field Values
    • SECTION

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

      Description: Classification of section (recommended)
      Type: token
      Path: Composition.section.code

    • SP_ENCOUNTER

      public static final String SP_ENCOUNTER
      Search parameter: encounter

      Description: Context of the Composition
      Type: reference
      Path: Composition.encounter

      See Also:
      Constant Field Values
    • ENCOUNTER

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ENCOUNTER
      Fluent Client search parameter constant for encounter

      Description: Context of the Composition
      Type: reference
      Path: Composition.encounter

    • INCLUDE_ENCOUNTER

      public static final ca.uhn.fhir.model.api.Include INCLUDE_ENCOUNTER
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Composition:encounter".
    • SP_TYPE

      public static final String SP_TYPE
      Search parameter: type

      Description: Kind of composition (LOINC if possible)
      Type: token
      Path: Composition.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: Kind of composition (LOINC if possible)
      Type: token
      Path: Composition.type

    • SP_TITLE

      public static final String SP_TITLE
      Search parameter: title

      Description: Human Readable name/title
      Type: string
      Path: Composition.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: Human Readable name/title
      Type: string
      Path: Composition.title

    • SP_ATTESTER

      public static final String SP_ATTESTER
      Search parameter: attester

      Description: Who attested the composition
      Type: reference
      Path: Composition.attester.party

      See Also:
      Constant Field Values
    • ATTESTER

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ATTESTER
      Fluent Client search parameter constant for attester

      Description: Who attested the composition
      Type: reference
      Path: Composition.attester.party

    • INCLUDE_ATTESTER

      public static final ca.uhn.fhir.model.api.Include INCLUDE_ATTESTER
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Composition:attester".
    • SP_ENTRY

      public static final String SP_ENTRY
      Search parameter: entry

      Description: A reference to data that supports this section
      Type: reference
      Path: Composition.section.entry

      See Also:
      Constant Field Values
    • ENTRY

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ENTRY
      Fluent Client search parameter constant for entry

      Description: A reference to data that supports this section
      Type: reference
      Path: Composition.section.entry

    • INCLUDE_ENTRY

      public static final ca.uhn.fhir.model.api.Include INCLUDE_ENTRY
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Composition:entry".
    • SP_PATIENT

      public static final String SP_PATIENT
      Search parameter: patient

      Description: Who and/or what the composition is about
      Type: reference
      Path: Composition.subject

      See Also:
      Constant Field Values
    • PATIENT

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
      Fluent Client search parameter constant for patient

      Description: Who and/or what the composition is about
      Type: reference
      Path: Composition.subject

    • INCLUDE_PATIENT

      public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Composition:patient".
    • SP_CONTEXT

      public static final String SP_CONTEXT
      Search parameter: context

      Description: Code(s) that apply to the event being documented
      Type: token
      Path: Composition.event.code

      See Also:
      Constant Field Values
    • CONTEXT

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

      Description: Code(s) that apply to the event being documented
      Type: token
      Path: Composition.event.code

    • SP_CLASS

      public static final String SP_CLASS
      Search parameter: class

      Description: Categorization of Composition
      Type: token
      Path: Composition.class

      See Also:
      Constant Field Values
    • CLASS

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

      Description: Categorization of Composition
      Type: token
      Path: Composition.class

    • SP_STATUS

      public static final String SP_STATUS
      Search parameter: status

      Description: preliminary | final | amended | entered-in-error
      Type: token
      Path: Composition.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: preliminary | final | amended | entered-in-error
      Type: token
      Path: Composition.status

  • Constructor Details

  • Method Details