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 Detail

      • identifier

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

        protected DateTimeType date
        The composition editing time, when the composition was last logically changed by the author.
      • 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_

        protected CodeableConcept 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.
      • title

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

        protected CodeType confidentiality
        The code specifying the level of confidentiality of the Composition.
      • 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

        protected Resource 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).)
      • author

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

        protected List<Resource> 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.)
      • custodian

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

        protected Organization 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.)
      • encounter

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

        protected Encounter encounterTarget
        The actual object that is the target of the reference (Describes the clinical encounter or type of care this documentation is associated with.)
      • 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

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

    • Method Detail

      • getIdentifier

        public Identifier getIdentifier()
        Returns:
        identifier (Logical identifier for the composition, assigned when created. This identifier stays constant as the composition is changed over time.)
      • setIdentifier

        public Composition setIdentifier​(Identifier value)
        Parameters:
        value - identifier (Logical identifier for the composition, assigned when created. This identifier stays constant as the composition is changed over time.)
      • getDateElement

        public DateTimeType getDateElement()
        Returns:
        date (The composition editing time, when the composition was last logically changed by the author.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
      • hasDate

        public boolean hasDate()
      • setDateElement

        public Composition setDateElement​(DateTimeType value)
        Parameters:
        value - date (The composition editing time, when the composition was last logically changed by the author.). 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 composition editing time, when the composition was last logically changed by the author.
      • setDate

        public Composition setDate​(Date value)
        Parameters:
        value - The composition editing time, when the composition was last logically changed by the author.
      • getType

        public CodeableConcept getType()
        Returns:
        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.)
      • hasType

        public boolean hasType()
      • setType

        public Composition setType​(CodeableConcept value)
        Parameters:
        value - 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.)
      • getClass_

        public CodeableConcept getClass_()
        Returns:
        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.)
      • setClass_

        public Composition setClass_​(CodeableConcept value)
        Parameters:
        value - 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.)
      • getTitleElement

        public StringType getTitleElement()
        Returns:
        title (Official human-readable label for the composition.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
      • setTitleElement

        public Composition setTitleElement​(StringType value)
        Parameters:
        value - title (Official human-readable label for the composition.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
      • getTitle

        public String getTitle()
        Returns:
        Official human-readable label for the composition.
      • setTitle

        public Composition setTitle​(String value)
        Parameters:
        value - Official human-readable label for the composition.
      • getStatusElement

        public Enumeration<Composition.CompositionStatusgetStatusElement()
        Returns:
        status (The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
      • setStatusElement

        public Composition setStatusElement​(Enumeration<Composition.CompositionStatus> value)
        Parameters:
        value - status (The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
      • getConfidentialityElement

        public CodeType getConfidentialityElement()
        Returns:
        confidentiality (The code specifying the level of confidentiality of the Composition.). This is the underlying object with id, value and extensions. The accessor "getConfidentiality" gives direct access to the value
      • setConfidentialityElement

        public Composition setConfidentialityElement​(CodeType value)
        Parameters:
        value - confidentiality (The code specifying the level of confidentiality of the Composition.). This is the underlying object with id, value and extensions. The accessor "getConfidentiality" gives direct access to the value
      • getConfidentiality

        public String getConfidentiality()
        Returns:
        The code specifying the level of confidentiality of the Composition.
      • getSubject

        public Reference getSubject()
        Returns:
        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).)
      • setSubject

        public Composition setSubject​(Reference value)
        Parameters:
        value - 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).)
      • getSubjectTarget

        public Resource getSubjectTarget()
        Returns:
        subject The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (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).)
      • setSubjectTarget

        public Composition setSubjectTarget​(Resource value)
        Parameters:
        value - subject The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (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).)
      • getAuthor

        public List<ReferencegetAuthor()
        Returns:
        author (Identifies who is responsible for the information in the composition, not necessarily who typed it in.)
      • addAuthor

        public Reference addAuthor()
        Returns:
        author (Identifies who is responsible for the information in the composition, not necessarily who typed it in.)
      • getAuthorTarget

        public List<ResourcegetAuthorTarget()
        Returns:
        author (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. Identifies who is responsible for the information in the composition, not necessarily who typed it in.)
      • getCustodian

        public Reference getCustodian()
        Returns:
        custodian (Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.)
      • setCustodian

        public Composition setCustodian​(Reference value)
        Parameters:
        value - custodian (Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.)
      • getCustodianTarget

        public Organization getCustodianTarget()
        Returns:
        custodian The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.)
      • setCustodianTarget

        public Composition setCustodianTarget​(Organization value)
        Parameters:
        value - custodian The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.)
      • getEncounter

        public Reference getEncounter()
        Returns:
        encounter (Describes the clinical encounter or type of care this documentation is associated with.)
      • getEncounterTarget

        public Encounter getEncounterTarget()
        Returns:
        encounter The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Describes the clinical encounter or type of care this documentation is associated with.)
      • setEncounterTarget

        public Composition setEncounterTarget​(Encounter value)
        Parameters:
        value - encounter The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Describes the clinical encounter or type of care this documentation is associated with.)
      • getProperty

        public Base[] getProperty​(int hash,
                                  String name,
                                  boolean checkValid)
                           throws org.hl7.fhir.exceptions.FHIRException
        Overrides:
        getProperty in class DomainResource
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • makeProperty

        public Base makeProperty​(int hash,
                                 String name)
                          throws org.hl7.fhir.exceptions.FHIRException
        Description copied from class: Base
        make an instance of a property. If the property is a repeating property, make a new instance. if the property is not repeating, return the property
        Overrides:
        makeProperty in class DomainResource
        Returns:
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • isEmpty

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