Class Composition

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource

    public class Composition
    extends BaseResource
    implements ca.uhn.fhir.model.api.IResource
    HAPI/FHIR Composition Resource ()

    Definition: 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

    Requirements: To support documents, and also to capture the EN13606 notion of an attested commit to the patient EHR, and to allow a set of disparate resources at the information/engineering level to be gathered into a clinical statement

    Profile Definition: http://hl7.org/fhir/profiles/Composition

    See Also:
    Serialized Form
    • Field Detail

      • TYPE

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

        Description:
        Type: token
        Path: Composition.type

      • CLASS

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

        Description:
        Type: token
        Path: Composition.class

      • DATE

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

        Description:
        Type: date
        Path: Composition.date

      • SUBJECT

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

        Description:
        Type: reference
        Path: Composition.subject

      • AUTHOR

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

        Description:
        Type: reference
        Path: Composition.author

      • ATTESTER

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

        Description:
        Type: reference
        Path: Composition.attester.party

      • CONTEXT

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

        Description:
        Type: token
        Path: Composition.event.code

      • SECTION

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

        Description:
        Type: token
        Path: Composition.section.code

      • SP_ENTRY

        public static final String SP_ENTRY
        Search parameter constant for entry

        Description:
        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:
        Type: reference
        Path: Composition.section.entry

      • IDENTIFIER

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

        Description:
        Type: token
        Path: Composition.identifier

      • TITLE

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

        Description:
        Type: string
        Path: Composition.title

      • STATUS

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

        Description:
        Type: token
        Path: Composition.status

      • CONFIDENTIALITY

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

        Description:
        Type: token
        Path: Composition.confidentiality

      • PERIOD

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

        Description:
        Type: date
        Path: Composition.event.period

      • PATIENT

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

        Description:
        Type: reference
        Path: Composition.subject

      • ENCOUNTER

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

        Description:
        Type: reference
        Path: Composition.encounter

      • 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".
      • 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".
      • 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".
      • 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".
      • 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".
      • 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".
    • Method Detail

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      • getAllPopulatedChildElementsOfType

        public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
        Specified by:
        getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
      • getIdentifier

        public IdentifierDt getIdentifier()
        Gets the value(s) for identifier (). creating it if it does not exist. Will not return null.

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

      • setIdentifier

        public Composition setIdentifier​(IdentifierDt theValue)
        Sets the value(s) for identifier ()

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

      • getDateElement

        public ca.uhn.fhir.model.primitive.DateTimeDt getDateElement()
        Gets the value(s) for date (). creating it if it does not exist. Will not return null.

        Definition: The composition editing time, when the composition was last logically changed by the author

      • getDate

        public Date getDate()
        Gets the value(s) for date (). creating it if it does not exist. This method may return null.

        Definition: The composition editing time, when the composition was last logically changed by the author

      • setDate

        public Composition setDate​(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
        Sets the value(s) for date ()

        Definition: The composition editing time, when the composition was last logically changed by the author

      • setDate

        public Composition setDate​(Date theDate,
                                   ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
        Sets the value for date ()

        Definition: The composition editing time, when the composition was last logically changed by the author

      • setDateWithSecondsPrecision

        public Composition setDateWithSecondsPrecision​(Date theDate)
        Sets the value for date ()

        Definition: The composition editing time, when the composition was last logically changed by the author

      • getType

        public CodeableConceptDt getType()
        Gets the value(s) for type (). creating it if it does not exist. Will not return null.

        Definition: 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

      • setType

        public Composition setType​(CodeableConceptDt theValue)
        Sets the value(s) for type ()

        Definition: 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

      • getClassElement

        public CodeableConceptDt getClassElement()
        Gets the value(s) for class (). creating it if it does not exist. Will not return null.

        Definition: 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

      • setClassElement

        public Composition setClassElement​(CodeableConceptDt theValue)
        Sets the value(s) for class ()

        Definition: 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 ca.uhn.fhir.model.primitive.StringDt getTitleElement()
        Gets the value(s) for title (). creating it if it does not exist. Will not return null.

        Definition: Official human-readable label for the composition

      • getTitle

        public String getTitle()
        Gets the value(s) for title (). creating it if it does not exist. This method may return null.

        Definition: Official human-readable label for the composition

      • setTitle

        public Composition setTitle​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for title ()

        Definition: Official human-readable label for the composition

      • setTitle

        public Composition setTitle​(String theString)
        Sets the value for title ()

        Definition: Official human-readable label for the composition

      • getStatusElement

        public ca.uhn.fhir.model.primitive.BoundCodeDt<CompositionStatusEnumgetStatusElement()
        Gets the value(s) for status (). creating it if it does not exist. Will not return null.

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

      • getStatus

        public String getStatus()
        Gets the value(s) for status (). creating it if it does not exist. This method may return null.

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

      • setStatus

        public Composition setStatus​(ca.uhn.fhir.model.primitive.BoundCodeDt<CompositionStatusEnum> theValue)
        Sets the value(s) for status ()

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

      • setStatus

        public Composition setStatus​(CompositionStatusEnum theValue)
        Sets the value(s) for status ()

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

      • getConfidentialityElement

        public ca.uhn.fhir.model.primitive.CodeDt getConfidentialityElement()
        Gets the value(s) for confidentiality (). creating it if it does not exist. Will not return null.

        Definition: The code specifying the level of confidentiality of the Composition

      • getConfidentiality

        public String getConfidentiality()
        Gets the value(s) for confidentiality (). creating it if it does not exist. This method may return null.

        Definition: The code specifying the level of confidentiality of the Composition

      • setConfidentiality

        public Composition setConfidentiality​(ca.uhn.fhir.model.primitive.CodeDt theValue)
        Sets the value(s) for confidentiality ()

        Definition: The code specifying the level of confidentiality of the Composition

      • setConfidentiality

        public Composition setConfidentiality​(String theCode)
        Sets the value for confidentiality ()

        Definition: The code specifying the level of confidentiality of the Composition

      • getSubject

        public ResourceReferenceDt getSubject()
        Gets the value(s) for subject (). creating it if it does not exist. Will not return null.

        Definition: 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​(ResourceReferenceDt theValue)
        Sets the value(s) for subject ()

        Definition: 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<ResourceReferenceDtgetAuthor()
        Gets the value(s) for author (). creating it if it does not exist. Will not return null.

        Definition: Identifies who is responsible for the information in the composition, not necessarily who typed it in.

      • setAuthor

        public Composition setAuthor​(List<ResourceReferenceDt> theValue)
        Sets the value(s) for author ()

        Definition: Identifies who is responsible for the information in the composition, not necessarily who typed it in.

      • addAuthor

        public ResourceReferenceDt addAuthor()
        Adds and returns a new value for author ()

        Definition: Identifies who is responsible for the information in the composition, not necessarily who typed it in.

      • getAttester

        public List<Composition.AttestergetAttester()
        Gets the value(s) for attester (). creating it if it does not exist. Will not return null.

        Definition: A participant who has attested to the accuracy of the composition/document

      • addAttester

        public Composition.Attester addAttester()
        Adds and returns a new value for attester ()

        Definition: A participant who has attested to the accuracy of the composition/document

      • addAttester

        public Composition addAttester​(Composition.Attester theValue)
        Adds a given new value for attester ()

        Definition: A participant who has attested to the accuracy of the composition/document

        Parameters:
        theValue - The attester to add (must not be null)
      • getAttesterFirstRep

        public Composition.Attester getAttesterFirstRep()
        Gets the first repetition for attester (), creating it if it does not already exist.

        Definition: A participant who has attested to the accuracy of the composition/document

      • getCustodian

        public ResourceReferenceDt getCustodian()
        Gets the value(s) for custodian (). creating it if it does not exist. Will not return null.

        Definition: Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information

      • setCustodian

        public Composition setCustodian​(ResourceReferenceDt theValue)
        Sets the value(s) for custodian ()

        Definition: Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information

      • getEvent

        public List<Composition.EventgetEvent()
        Gets the value(s) for event (). creating it if it does not exist. Will not return null.

        Definition: The clinical service, such as a colonoscopy or an appendectomy, being documented

      • setEvent

        public Composition setEvent​(List<Composition.Event> theValue)
        Sets the value(s) for event ()

        Definition: The clinical service, such as a colonoscopy or an appendectomy, being documented

      • addEvent

        public Composition.Event addEvent()
        Adds and returns a new value for event ()

        Definition: The clinical service, such as a colonoscopy or an appendectomy, being documented

      • addEvent

        public Composition addEvent​(Composition.Event theValue)
        Adds a given new value for event ()

        Definition: The clinical service, such as a colonoscopy or an appendectomy, being documented

        Parameters:
        theValue - The event to add (must not be null)
      • getEventFirstRep

        public Composition.Event getEventFirstRep()
        Gets the first repetition for event (), creating it if it does not already exist.

        Definition: The clinical service, such as a colonoscopy or an appendectomy, being documented

      • getEncounter

        public ResourceReferenceDt getEncounter()
        Gets the value(s) for encounter (). creating it if it does not exist. Will not return null.

        Definition: Describes the clinical encounter or type of care this documentation is associated with.

      • setEncounter

        public Composition setEncounter​(ResourceReferenceDt theValue)
        Sets the value(s) for encounter ()

        Definition: Describes the clinical encounter or type of care this documentation is associated with.

      • getSection

        public List<Composition.SectiongetSection()
        Gets the value(s) for section (). creating it if it does not exist. Will not return null.

        Definition: The root of the sections that make up the composition

      • addSection

        public Composition.Section addSection()
        Adds and returns a new value for section ()

        Definition: The root of the sections that make up the composition

      • addSection

        public Composition addSection​(Composition.Section theValue)
        Adds a given new value for section ()

        Definition: The root of the sections that make up the composition

        Parameters:
        theValue - The section to add (must not be null)
      • getSectionFirstRep

        public Composition.Section getSectionFirstRep()
        Gets the first repetition for section (), creating it if it does not already exist.

        Definition: The root of the sections that make up the composition

      • getResourceName

        public String getResourceName()
        Specified by:
        getResourceName in interface ca.uhn.fhir.model.api.IResource
      • getStructureFhirVersionEnum

        public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
        Specified by:
        getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
        Specified by:
        getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource