ca.uhn.fhir.model.dstu.resource

Class Composition

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseResource

ca.uhn.fhir.model.dstu.resource.Composition

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions

public class Composition
extends BaseResource
implements IResource

HAPI/FHIR Composition Resource (A set of resources composed into a single coherent clinical statement with clinical attestation)

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.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Composition.Attester Block class for child element: Composition.attester (Attests to accuracy of composition)
static class	Composition.Event Block class for child element: Composition.event (The clinical event/act/item being documented)
static class	Composition.Section Block class for child element: Composition.section (Composition is broken into sections)

Field Summary

Fields

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	CONTEXT Fluent Client search parameter constant for context
static DateClientParam	DATE Fluent Client search parameter constant for date
static TokenClientParam	IDENTIFIER Fluent Client search parameter constant for identifier
static Include	INCLUDE_ATTESTER_PARTY 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_SECTION_CONTENT 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	SECTION_CONTENT Fluent Client search parameter constant for section-content
static TokenClientParam	SECTION_TYPE Fluent Client search parameter constant for section-type
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_CONTEXT Search parameter constant for context
static String	SP_DATE Search parameter constant for date
static String	SP_IDENTIFIER Search parameter constant for identifier
static String	SP_SECTION_CONTENT Search parameter constant for section-content
static String	SP_SECTION_TYPE Search parameter constant for section-type
static String	SP_SUBJECT Search parameter constant for subject
static String	SP_TYPE Search parameter constant for type
static ReferenceClientParam	SUBJECT Fluent Client search parameter constant for subject
static TokenClientParam	TYPE Fluent Client search parameter constant for type

Fields inherited from class ca.uhn.fhir.model.api.BaseResource

SP_RES_ID, SP_RES_LANGUAGE

Constructor Summary

Constructors

Constructor and Description
Composition()

Method Summary

Methods

Modifier and Type	Method and Description
Composition.Attester	addAttester() Adds and returns a new value for attester (Attests to accuracy of composition)
ResourceReferenceDt	addAuthor() Adds and returns a new value for author (Who and/or what authored the composition)
Composition.Section	addSection() Adds and returns a new value for section (Composition is broken into sections)
<T extends IElement> List<T>	getAllPopulatedChildElementsOfType(Class<T> theType) Returns a list containing all child elements matching a given type
List<Composition.Attester>	getAttester() Gets the value(s) for attester (Attests to accuracy of composition).
Composition.Attester	getAttesterFirstRep() Gets the first repetition for attester (Attests to accuracy of composition), creating it if it does not already exist.
List<ResourceReferenceDt>	getAuthor() Gets the value(s) for author (Who and/or what authored the composition).
CodeableConceptDt	getClassElement() Gets the value(s) for class (Categorization of Composition).
CodingDt	getConfidentiality() Gets the value(s) for confidentiality (As defined by affinity domain).
ResourceReferenceDt	getCustodian() Gets the value(s) for custodian (Org which maintains the composition).
DateTimeDt	getDate() Gets the value(s) for date (Composition editing time).
ResourceReferenceDt	getEncounter() Gets the value(s) for encounter (Context of the conposition).
Composition.Event	getEvent() Gets the value(s) for event (The clinical event/act/item being documented).
IdentifierDt	getIdentifier() Gets the value(s) for identifier (Logical identifier of composition (version-independent)).
List<Composition.Section>	getSection() Gets the value(s) for section (Composition is broken into sections).
Composition.Section	getSectionFirstRep() Gets the first repetition for section (Composition is broken into sections), creating it if it does not already exist.
BoundCodeDt<CompositionStatusEnum>	getStatus() Gets the value(s) for status (preliminary | final | appended | amended | entered in error).
ResourceReferenceDt	getSubject() Gets the value(s) for subject (Who and/or what the composition is about).
StringDt	getTitle() Gets the value(s) for title (Human Readable name/title).
CodeableConceptDt	getType() Gets the value(s) for type (Kind of composition (LOINC if possible)).
boolean	isEmpty()
Composition	setAttester(List<Composition.Attester> theValue) Sets the value(s) for attester (Attests to accuracy of composition)
Composition	setAuthor(List<ResourceReferenceDt> theValue) Sets the value(s) for author (Who and/or what authored the composition)
Composition	setClassElement(CodeableConceptDt theValue) Sets the value(s) for class (Categorization of Composition)
Composition	setConfidentiality(CodingDt theValue) Sets the value(s) for confidentiality (As defined by affinity domain)
Composition	setCustodian(ResourceReferenceDt theValue) Sets the value(s) for custodian (Org which maintains the composition)
Composition	setDate(Date theDate, TemporalPrecisionEnum thePrecision) Sets the value for date (Composition editing time)
Composition	setDate(DateTimeDt theValue) Sets the value(s) for date (Composition editing time)
Composition	setDateWithSecondsPrecision(Date theDate) Sets the value for date (Composition editing time)
Composition	setEncounter(ResourceReferenceDt theValue) Sets the value(s) for encounter (Context of the conposition)
Composition	setEvent(Composition.Event theValue) Sets the value(s) for event (The clinical event/act/item being documented)
Composition	setIdentifier(IdentifierDt theValue) Sets the value(s) for identifier (Logical identifier of composition (version-independent))
Composition	setIdentifier(IdentifierUseEnum theUse, String theSystem, String theValue, String theLabel) Sets the value for identifier (Logical identifier of composition (version-independent))
Composition	setIdentifier(String theSystem, String theValue) Sets the value for identifier (Logical identifier of composition (version-independent))
Composition	setSection(List<Composition.Section> theValue) Sets the value(s) for section (Composition is broken into sections)
Composition	setStatus(BoundCodeDt<CompositionStatusEnum> theValue) Sets the value(s) for status (preliminary | final | appended | amended | entered in error)
Composition	setStatus(CompositionStatusEnum theValue) Sets the value(s) for status (preliminary | final | appended | amended | entered in error)
Composition	setSubject(ResourceReferenceDt theValue) Sets the value(s) for subject (Who and/or what the composition is about)
Composition	setTitle(String theString) Sets the value for title (Human Readable name/title)
Composition	setTitle(StringDt theValue) Sets the value(s) for title (Human Readable name/title)
Composition	setType(CodeableConceptDt theValue) Sets the value(s) for type (Kind of composition (LOINC if possible))

Methods inherited from class ca.uhn.fhir.model.api.BaseResource

getContained, getId, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setLanguage, setResourceMetadata, setText, toString

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ca.uhn.fhir.model.api.IResource

getContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata

Field Detail

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 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 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 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 ReferenceClientParam SUBJECT

Fluent Client search parameter constant for subject

Description:
Type: reference
Path: Composition.subject

INCLUDE_SUBJECT

public static final 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 constant for author

Description:
Type: reference
Path: Composition.author

See Also:

Constant Field Values

AUTHOR

public static final ReferenceClientParam AUTHOR

Fluent Client search parameter constant for author

Description:
Type: reference
Path: Composition.author

INCLUDE_AUTHOR

public static final Include INCLUDE_AUTHOR

Constant for fluent queries to be used to add include statements. Specifies the path value of "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 ReferenceClientParam ATTESTER

Fluent Client search parameter constant for attester

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

INCLUDE_ATTESTER_PARTY

public static final Include INCLUDE_ATTESTER_PARTY

Constant for fluent queries to be used to add include statements. Specifies the path value of "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 TokenClientParam CONTEXT

Fluent Client search parameter constant for context

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

SP_SECTION_TYPE

public static final String SP_SECTION_TYPE

Search parameter constant for section-type

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

See Also:

Constant Field Values

SECTION_TYPE

public static final TokenClientParam SECTION_TYPE

Fluent Client search parameter constant for section-type

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

SP_SECTION_CONTENT

public static final String SP_SECTION_CONTENT

Search parameter constant for section-content

Description:
Type: reference
Path: Composition.section.content

See Also:

Constant Field Values

SECTION_CONTENT

public static final ReferenceClientParam SECTION_CONTENT

Fluent Client search parameter constant for section-content

Description:
Type: reference
Path: Composition.section.content

INCLUDE_SECTION_CONTENT

public static final Include INCLUDE_SECTION_CONTENT

Constant for fluent queries to be used to add include statements. Specifies the path value of "Composition.section.content".

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 TokenClientParam IDENTIFIER

Fluent Client search parameter constant for identifier

Description:
Type: token
Path: Composition.identifier

Constructor Detail

Composition

public Composition()

Method Detail

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IElement

getAllPopulatedChildElementsOfType

public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)

Description copied from interface: ICompositeElement

Returns a list containing all child elements matching a given type

Specified by:

getAllPopulatedChildElementsOfType in interface ICompositeElement

Parameters:

theType - The type to match. If set to null, all child elements will be returned

getIdentifier

public IdentifierDt getIdentifier()

Gets the value(s) for identifier (Logical identifier of composition (version-independent)). 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 (Logical identifier of composition (version-independent))

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

setIdentifier

public Composition setIdentifier(IdentifierUseEnum theUse,
                        String theSystem,
                        String theValue,
                        String theLabel)

Sets the value for identifier (Logical identifier of composition (version-independent))

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

setIdentifier

public Composition setIdentifier(String theSystem,
                        String theValue)

Sets the value for identifier (Logical identifier of composition (version-independent))

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

getDate

public DateTimeDt getDate()

Gets the value(s) for date (Composition editing time). 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

setDate

public Composition setDate(DateTimeDt theValue)

Sets the value(s) for date (Composition editing time)

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 (Composition editing time)

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

setDate

public Composition setDate(Date theDate,
                  TemporalPrecisionEnum thePrecision)

Sets the value for date (Composition editing time)

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 (Kind of composition (LOINC if possible)). 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 (Kind of composition (LOINC if possible))

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 (Categorization of Composition). creating it if it does not exist. Will not return null.

Definition: A categorization for the type of the composition. 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 (Categorization of Composition)

Definition: A categorization for the type of the composition. This may be implied by or derived from the code specified in the Composition Type

getTitle

public StringDt getTitle()

Gets the value(s) for title (Human Readable name/title). creating it if it does not exist. Will not return null.

Definition: Official human-readable label for the composition

setTitle

public Composition setTitle(StringDt theValue)

Sets the value(s) for title (Human Readable name/title)

Definition: Official human-readable label for the composition

setTitle

public Composition setTitle(String theString)

Sets the value for title (Human Readable name/title)

Definition: Official human-readable label for the composition

getStatus

public BoundCodeDt<CompositionStatusEnum> getStatus()

Gets the value(s) for status (preliminary | final | appended | amended | entered in error). 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

setStatus

public Composition setStatus(BoundCodeDt<CompositionStatusEnum> theValue)

Sets the value(s) for status (preliminary | final | appended | amended | entered in error)

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 (preliminary | final | appended | amended | entered in error)

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

getConfidentiality

public CodingDt getConfidentiality()

Gets the value(s) for confidentiality (As defined by affinity domain). creating it if it does not exist. Will not return null.

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

setConfidentiality

public Composition setConfidentiality(CodingDt theValue)

Sets the value(s) for confidentiality (As defined by affinity domain)

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

getSubject

public ResourceReferenceDt getSubject()

Gets the value(s) for subject (Who and/or what the composition is about). 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 (I.e. 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 (Who and/or what the composition is about)

Definition: Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (I.e. 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<ResourceReferenceDt> getAuthor()

Gets the value(s) for author (Who and/or what authored the composition). 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 (Who and/or what authored the composition)

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 (Who and/or what authored the composition)

Definition: Identifies who is responsible for the information in the composition. (Not necessarily who typed it in.)

getAttester

public List<Composition.Attester> getAttester()

Gets the value(s) for attester (Attests to accuracy of composition). 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

public Composition setAttester(List<Composition.Attester> theValue)

Sets the value(s) for attester (Attests to accuracy of composition)

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 (Attests to accuracy of composition)

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

getAttesterFirstRep

public Composition.Attester getAttesterFirstRep()

Gets the first repetition for attester (Attests to accuracy of composition), 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 (Org which maintains the composition). 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 (Org which maintains the composition)

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

getEvent

public Composition.Event getEvent()

Gets the value(s) for event (The clinical event/act/item being documented). creating it if it does not exist. Will not return null.

Definition: The main event/act/item, such as a colonoscopy or an appendectomy, being documented

setEvent

public Composition setEvent(Composition.Event theValue)

Sets the value(s) for event (The clinical event/act/item being documented)

Definition: The main event/act/item, such as a colonoscopy or an appendectomy, being documented

getEncounter

public ResourceReferenceDt getEncounter()

Gets the value(s) for encounter (Context of the conposition). 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 (Context of the conposition)

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

getSection

public List<Composition.Section> getSection()

Gets the value(s) for section (Composition is broken into sections). creating it if it does not exist. Will not return null.

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

setSection

public Composition setSection(List<Composition.Section> theValue)

Sets the value(s) for section (Composition is broken into sections)

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

addSection

public Composition.Section addSection()

Adds and returns a new value for section (Composition is broken into sections)

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

getSectionFirstRep

public Composition.Section getSectionFirstRep()

Gets the first repetition for section (Composition is broken into sections), creating it if it does not already exist.

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