public class Composition extends BaseResource implements IResource
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
| Modifier and Type | Class and Description |
|---|---|
static class |
Composition.Attester
Block class for child element: Composition.attester ()
|
static class |
Composition.Event
Block class for child element: Composition.event ()
|
static class |
Composition.Section
Block class for child element: Composition.section ()
|
| Modifier and Type | Field and Description |
|---|---|
static ReferenceClientParam |
ATTESTER
Fluent Client search parameter constant for attester
|
static ReferenceClientParam |
AUTHOR
Fluent Client search parameter constant for author
|
static TokenClientParam |
CLASS
Fluent Client search parameter constant for class
|
static TokenClientParam |
CONFIDENTIALITY
Fluent Client search parameter constant for confidentiality
|
static TokenClientParam |
CONTEXT
Fluent Client search parameter constant for context
|
static DateClientParam |
DATE
Fluent Client search parameter constant for date
|
static ReferenceClientParam |
ENCOUNTER
Fluent Client search parameter constant for encounter
|
static ReferenceClientParam |
ENTRY
Fluent Client search parameter constant for entry
|
static TokenClientParam |
IDENTIFIER
Fluent Client search parameter constant for identifier
|
static Include |
INCLUDE_ATTESTER
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_AUTHOR
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_ENCOUNTER
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_ENTRY
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements.
|
static ReferenceClientParam |
PATIENT
Fluent Client search parameter constant for patient
|
static DateClientParam |
PERIOD
Fluent Client search parameter constant for period
|
static TokenClientParam |
SECTION
Fluent Client search parameter constant for section
|
static String |
SP_ATTESTER
Search parameter constant for attester
|
static String |
SP_AUTHOR
Search parameter constant for author
|
static String |
SP_CLASS
Search parameter constant for class
|
static String |
SP_CONFIDENTIALITY
Search parameter constant for confidentiality
|
static String |
SP_CONTEXT
Search parameter constant for context
|
static String |
SP_DATE
Search parameter constant for date
|
static String |
SP_ENCOUNTER
Search parameter constant for encounter
|
static String |
SP_ENTRY
Search parameter constant for entry
|
static String |
SP_IDENTIFIER
Search parameter constant for identifier
|
static String |
SP_PATIENT
Search parameter constant for patient
|
static String |
SP_PERIOD
Search parameter constant for period
|
static String |
SP_SECTION
Search parameter constant for section
|
static String |
SP_STATUS
Search parameter constant for status
|
static String |
SP_SUBJECT
Search parameter constant for subject
|
static String |
SP_TITLE
Search parameter constant for title
|
static String |
SP_TYPE
Search parameter constant for type
|
static TokenClientParam |
STATUS
Fluent Client search parameter constant for status
|
static ReferenceClientParam |
SUBJECT
Fluent Client search parameter constant for subject
|
static StringClientParam |
TITLE
Fluent Client search parameter constant for title
|
static TokenClientParam |
TYPE
Fluent Client search parameter constant for type
|
RES_ID, SP_RES_ID, SP_RES_LANGUAGEINCLUDE_ALL, WILDCARD_ALL_SET| Constructor and Description |
|---|
Composition() |
| Modifier and Type | Method and Description |
|---|---|
Composition.Attester |
addAttester()
Adds and returns a new value for attester ()
|
Composition |
addAttester(Composition.Attester theValue)
Adds a given new value for attester ()
|
ResourceReferenceDt |
addAuthor()
Adds and returns a new value for author ()
|
Composition.Event |
addEvent()
Adds and returns a new value for event ()
|
Composition |
addEvent(Composition.Event theValue)
Adds a given new value for event ()
|
Composition.Section |
addSection()
Adds and returns a new value for section ()
|
Composition |
addSection(Composition.Section theValue)
Adds a given new value for section ()
|
<T extends IElement> |
getAllPopulatedChildElementsOfType(Class<T> theType) |
List<Composition.Attester> |
getAttester()
Gets the value(s) for attester ().
|
Composition.Attester |
getAttesterFirstRep()
Gets the first repetition for attester (),
creating it if it does not already exist.
|
List<ResourceReferenceDt> |
getAuthor()
Gets the value(s) for author ().
|
CodeableConceptDt |
getClassElement()
Gets the value(s) for class ().
|
String |
getConfidentiality()
Gets the value(s) for confidentiality ().
|
CodeDt |
getConfidentialityElement()
Gets the value(s) for confidentiality ().
|
ResourceReferenceDt |
getCustodian()
Gets the value(s) for custodian ().
|
Date |
getDate()
Gets the value(s) for date ().
|
DateTimeDt |
getDateElement()
Gets the value(s) for date ().
|
ResourceReferenceDt |
getEncounter()
Gets the value(s) for encounter ().
|
List<Composition.Event> |
getEvent()
Gets the value(s) for event ().
|
Composition.Event |
getEventFirstRep()
Gets the first repetition for event (),
creating it if it does not already exist.
|
IdentifierDt |
getIdentifier()
Gets the value(s) for identifier ().
|
String |
getResourceName() |
List<Composition.Section> |
getSection()
Gets the value(s) for section ().
|
Composition.Section |
getSectionFirstRep()
Gets the first repetition for section (),
creating it if it does not already exist.
|
String |
getStatus()
Gets the value(s) for status ().
|
BoundCodeDt<CompositionStatusEnum> |
getStatusElement()
Gets the value(s) for status ().
|
FhirVersionEnum |
getStructureFhirVersionEnum() |
ResourceReferenceDt |
getSubject()
Gets the value(s) for subject ().
|
String |
getTitle()
Gets the value(s) for title ().
|
StringDt |
getTitleElement()
Gets the value(s) for title ().
|
CodeableConceptDt |
getType()
Gets the value(s) for type ().
|
boolean |
isEmpty() |
Composition |
setAttester(List<Composition.Attester> theValue)
Sets the value(s) for attester ()
|
Composition |
setAuthor(List<ResourceReferenceDt> theValue)
Sets the value(s) for author ()
|
Composition |
setClassElement(CodeableConceptDt theValue)
Sets the value(s) for class ()
|
Composition |
setConfidentiality(CodeDt theValue)
Sets the value(s) for confidentiality ()
|
Composition |
setConfidentiality(String theCode)
Sets the value for confidentiality ()
|
Composition |
setCustodian(ResourceReferenceDt theValue)
Sets the value(s) for custodian ()
|
Composition |
setDate(Date theDate,
TemporalPrecisionEnum thePrecision)
Sets the value for date ()
|
Composition |
setDate(DateTimeDt theValue)
Sets the value(s) for date ()
|
Composition |
setDateWithSecondsPrecision(Date theDate)
Sets the value for date ()
|
Composition |
setEncounter(ResourceReferenceDt theValue)
Sets the value(s) for encounter ()
|
Composition |
setEvent(List<Composition.Event> theValue)
Sets the value(s) for event ()
|
Composition |
setIdentifier(IdentifierDt theValue)
Sets the value(s) for identifier ()
|
Composition |
setSection(List<Composition.Section> theValue)
Sets the value(s) for section ()
|
Composition |
setStatus(BoundCodeDt<CompositionStatusEnum> theValue)
Sets the value(s) for status ()
|
Composition |
setStatus(CompositionStatusEnum theValue)
Sets the value(s) for status ()
|
Composition |
setSubject(ResourceReferenceDt theValue)
Sets the value(s) for subject ()
|
Composition |
setTitle(String theString)
Sets the value for title ()
|
Composition |
setTitle(StringDt theValue)
Sets the value(s) for title ()
|
Composition |
setType(CodeableConceptDt theValue)
Sets the value(s) for type ()
|
getContained, getId, getIdElement, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toStringaddUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensionsclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitgetContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadatagetIdElement, setId, setIdpublic static final String SP_TYPE
Description:
Type: token
Path: Composition.type
public static final TokenClientParam TYPE
Description:
Type: token
Path: Composition.type
public static final String SP_CLASS
Description:
Type: token
Path: Composition.class
public static final TokenClientParam CLASS
Description:
Type: token
Path: Composition.class
public static final String SP_DATE
Description:
Type: date
Path: Composition.date
public static final DateClientParam DATE
Description:
Type: date
Path: Composition.date
public static final String SP_SUBJECT
Description:
Type: reference
Path: Composition.subject
public static final ReferenceClientParam SUBJECT
Description:
Type: reference
Path: Composition.subject
public static final String SP_AUTHOR
Description:
Type: reference
Path: Composition.author
public static final ReferenceClientParam AUTHOR
Description:
Type: reference
Path: Composition.author
public static final String SP_ATTESTER
Description:
Type: reference
Path: Composition.attester.party
public static final ReferenceClientParam ATTESTER
Description:
Type: reference
Path: Composition.attester.party
public static final String SP_CONTEXT
Description:
Type: token
Path: Composition.event.code
public static final TokenClientParam CONTEXT
Description:
Type: token
Path: Composition.event.code
public static final String SP_SECTION
Description:
Type: token
Path: Composition.section.code
public static final TokenClientParam SECTION
Description:
Type: token
Path: Composition.section.code
public static final String SP_ENTRY
Description:
Type: reference
Path: Composition.section.entry
public static final ReferenceClientParam ENTRY
Description:
Type: reference
Path: Composition.section.entry
public static final String SP_IDENTIFIER
Description:
Type: token
Path: Composition.identifier
public static final TokenClientParam IDENTIFIER
Description:
Type: token
Path: Composition.identifier
public static final String SP_TITLE
Description:
Type: string
Path: Composition.title
public static final StringClientParam TITLE
Description:
Type: string
Path: Composition.title
public static final String SP_STATUS
Description:
Type: token
Path: Composition.status
public static final TokenClientParam STATUS
Description:
Type: token
Path: Composition.status
public static final String SP_CONFIDENTIALITY
Description:
Type: token
Path: Composition.confidentiality
public static final TokenClientParam CONFIDENTIALITY
Description:
Type: token
Path: Composition.confidentiality
public static final String SP_PERIOD
Description:
Type: date
Path: Composition.event.period
public static final DateClientParam PERIOD
Description:
Type: date
Path: Composition.event.period
public static final String SP_PATIENT
Description:
Type: reference
Path: Composition.subject
public static final ReferenceClientParam PATIENT
Description:
Type: reference
Path: Composition.subject
public static final String SP_ENCOUNTER
Description:
Type: reference
Path: Composition.encounter
public static final ReferenceClientParam ENCOUNTER
Description:
Type: reference
Path: Composition.encounter
public static final Include INCLUDE_ATTESTER
public static final Include INCLUDE_AUTHOR
public static final Include INCLUDE_ENCOUNTER
public static final Include INCLUDE_ENTRY
public static final Include INCLUDE_PATIENT
public static final Include INCLUDE_SUBJECT
public Composition()
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
getAllPopulatedChildElementsOfType in interface ICompositeElementpublic IdentifierDt getIdentifier()
null.
Definition: Logical identifier for the composition, assigned when created. This identifier stays constant as the composition is changed over time
public Composition setIdentifier(IdentifierDt theValue)
Definition: Logical identifier for the composition, assigned when created. This identifier stays constant as the composition is changed over time
public DateTimeDt getDateElement()
null.
Definition: The composition editing time, when the composition was last logically changed by the author
public Date getDate()
null.
Definition: The composition editing time, when the composition was last logically changed by the author
public Composition setDate(DateTimeDt theValue)
Definition: The composition editing time, when the composition was last logically changed by the author
public Composition setDate(Date theDate, TemporalPrecisionEnum thePrecision)
Definition: The composition editing time, when the composition was last logically changed by the author
public Composition setDateWithSecondsPrecision(Date theDate)
Definition: The composition editing time, when the composition was last logically changed by the author
public CodeableConceptDt getType()
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
public Composition setType(CodeableConceptDt theValue)
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
public CodeableConceptDt getClassElement()
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
public Composition setClassElement(CodeableConceptDt theValue)
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
public StringDt getTitleElement()
null.
Definition: Official human-readable label for the composition
public String getTitle()
null.
Definition: Official human-readable label for the composition
public Composition setTitle(StringDt theValue)
Definition: Official human-readable label for the composition
public Composition setTitle(String theString)
Definition: Official human-readable label for the composition
public BoundCodeDt<CompositionStatusEnum> getStatusElement()
null.
Definition: The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document
public String getStatus()
null.
Definition: The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document
public Composition setStatus(BoundCodeDt<CompositionStatusEnum> theValue)
Definition: The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document
public Composition setStatus(CompositionStatusEnum theValue)
Definition: The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document
public CodeDt getConfidentialityElement()
null.
Definition: The code specifying the level of confidentiality of the Composition
public String getConfidentiality()
null.
Definition: The code specifying the level of confidentiality of the Composition
public Composition setConfidentiality(CodeDt theValue)
Definition: The code specifying the level of confidentiality of the Composition
public Composition setConfidentiality(String theCode)
Definition: The code specifying the level of confidentiality of the Composition
public ResourceReferenceDt getSubject()
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)
public Composition setSubject(ResourceReferenceDt theValue)
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)
public List<ResourceReferenceDt> getAuthor()
null.
Definition: Identifies who is responsible for the information in the composition, not necessarily who typed it in.
public Composition setAuthor(List<ResourceReferenceDt> theValue)
Definition: Identifies who is responsible for the information in the composition, not necessarily who typed it in.
public ResourceReferenceDt addAuthor()
Definition: Identifies who is responsible for the information in the composition, not necessarily who typed it in.
public List<Composition.Attester> getAttester()
null.
Definition: A participant who has attested to the accuracy of the composition/document
public Composition setAttester(List<Composition.Attester> theValue)
Definition: A participant who has attested to the accuracy of the composition/document
public Composition.Attester addAttester()
Definition: A participant who has attested to the accuracy of the composition/document
public Composition addAttester(Composition.Attester theValue)
Definition: A participant who has attested to the accuracy of the composition/document
theValue - The attester to add (must not be null)public Composition.Attester getAttesterFirstRep()
Definition: A participant who has attested to the accuracy of the composition/document
public ResourceReferenceDt getCustodian()
null.
Definition: Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information
public Composition setCustodian(ResourceReferenceDt theValue)
Definition: Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information
public List<Composition.Event> getEvent()
null.
Definition: The clinical service, such as a colonoscopy or an appendectomy, being documented
public Composition setEvent(List<Composition.Event> theValue)
Definition: The clinical service, such as a colonoscopy or an appendectomy, being documented
public Composition.Event addEvent()
Definition: The clinical service, such as a colonoscopy or an appendectomy, being documented
public Composition addEvent(Composition.Event theValue)
Definition: The clinical service, such as a colonoscopy or an appendectomy, being documented
theValue - The event to add (must not be null)public Composition.Event getEventFirstRep()
Definition: The clinical service, such as a colonoscopy or an appendectomy, being documented
public ResourceReferenceDt getEncounter()
null.
Definition: Describes the clinical encounter or type of care this documentation is associated with.
public Composition setEncounter(ResourceReferenceDt theValue)
Definition: Describes the clinical encounter or type of care this documentation is associated with.
public List<Composition.Section> getSection()
null.
Definition: The root of the sections that make up the composition
public Composition setSection(List<Composition.Section> theValue)
Definition: The root of the sections that make up the composition
public Composition.Section addSection()
Definition: The root of the sections that make up the composition
public Composition addSection(Composition.Section theValue)
Definition: The root of the sections that make up the composition
theValue - The section to add (must not be null)public Composition.Section getSectionFirstRep()
Definition: The root of the sections that make up the composition
public String getResourceName()
getResourceName in interface IResourcepublic FhirVersionEnum getStructureFhirVersionEnum()
getStructureFhirVersionEnum in interface IResourcegetStructureFhirVersionEnum in interface IBaseResourceCopyright © 2014–2016 University Health Network. All rights reserved.