Class Composition

java.lang.Object
ca.uhn.fhir.model.api.BaseElement
ca.uhn.fhir.model.dstu2.resource.BaseResource
ca.uhn.fhir.model.dstu2.resource.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 Details

    • SP_TYPE

      public static final String SP_TYPE
      Search parameter constant for type

      Description:
      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:
      Type: token
      Path: Composition.type

    • SP_CLASS

      public static final String SP_CLASS
      Search parameter constant for class

      Description:
      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:
      Type: token
      Path: Composition.class

    • SP_DATE

      public static final String SP_DATE
      Search parameter constant for date

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

    • SP_SUBJECT

      public static final String SP_SUBJECT
      Search parameter constant for subject

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

    • SP_AUTHOR

      public static final String SP_AUTHOR
      Search parameter constant for author

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

    • SP_ATTESTER

      public static final String SP_ATTESTER
      Search parameter constant for attester

      Description:
      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:
      Type: reference
      Path: Composition.attester.party

    • SP_CONTEXT

      public static final String SP_CONTEXT
      Search parameter constant for context

      Description:
      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:
      Type: token
      Path: Composition.event.code

    • SP_SECTION

      public static final String SP_SECTION
      Search parameter constant for section

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

    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter constant for identifier

      Description:
      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:
      Type: token
      Path: Composition.identifier

    • SP_TITLE

      public static final String SP_TITLE
      Search parameter constant for title

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

    • SP_STATUS

      public static final String SP_STATUS
      Search parameter constant for status

      Description:
      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:
      Type: token
      Path: Composition.status

    • SP_CONFIDENTIALITY

      public static final String SP_CONFIDENTIALITY
      Search parameter constant for confidentiality

      Description:
      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:
      Type: token
      Path: Composition.confidentiality

    • SP_PERIOD

      public static final String SP_PERIOD
      Search parameter constant for period

      Description:
      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:
      Type: date
      Path: Composition.event.period

    • SP_PATIENT

      public static final String SP_PATIENT
      Search parameter constant for patient

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

    • SP_ENCOUNTER

      public static final String SP_ENCOUNTER
      Search parameter constant for encounter

      Description:
      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:
      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".
  • Constructor Details

  • Method Details

    • 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

      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

      Sets the value for date ()

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

    • 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

      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

      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<CompositionStatusEnum> getStatusElement()
      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

      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

      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

      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

      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

      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

      Sets the value(s) for author ()

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

    • 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

      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

    • setAttester

      Sets the value(s) for attester ()

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

    • addAttester

      Adds and returns a new value for attester ()

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

    • addAttester

      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

      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

      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

      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

      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

      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

      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

      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

      Sets the value(s) for encounter ()

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

    • getSection

      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

    • setSection

      Sets the value(s) for section ()

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

    • addSection

      Adds and returns a new value for section ()

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

    • addSection

      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

      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

      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