A set of healthcare-related information that is assembled together into a single logical package 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. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.).
Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)
- Value parameters:
- `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.
- attester
- A participant who has attested to the accuracy of the composition/document.
- author
- Identifies who is responsible for the information in the composition, not necessarily who typed it in.
- category
- 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.
- confidentiality
- The code specifying the level of confidentiality of the Composition.
- contained
- These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- custodian
- Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.
- date
- The composition editing time, when the composition was last logically changed by the author.
- encounter
- Describes the clinical encounter or type of care this documentation is associated with.
- event
- The clinical service, such as a colonoscopy or an appendectomy, being documented.
- extension
- May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- id
- The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- identifier
- A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time.
- implicitRules
- A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- language
- The base language in which the resource is written.
- meta
- The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- modifierExtension
- May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- relatesTo
- Relationships that this composition has with other compositions or documents that already exist.
- section
- The root of the sections that make up the composition.
- status
- The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.
- 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).
- text
- A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- title
- Official human-readable label for the composition.
- Constructor:
Introduces the fields
type
, date, title, status, author, subject, category, encounter, custodian, identifier, confidentiality, event, section, attester, relatesTo.- Companion:
- object
Value members
Inherited methods
Slower than nodalMap, but should work with subtypes (e.g. PositiveInt). If you must use it, then:
Slower than nodalMap, but should work with subtypes (e.g. PositiveInt). If you must use it, then:
T
should not be a Choice[_], a LitSeq[_] or an Option[_]- It may require a type parameter sometimes (e.g.
sampleResource >>[BUNDLE_TYPE] { (_: BUNDLE_TYPE) => BUNDLE_TYPE.SEARCHSET }
)
- Inherited from:
- FHIRObject
- Inherited from:
- FHIRObject
Extract values of type From, and map to LitSeq[To] using fn: From => To. Unlike >>, this is safe even if From is a Choice[], a LitSeq[] or an Option[_] Quite slow, slower than nodalExtract
Extract values of type From, and map to LitSeq[To] using fn: From => To. Unlike >>, this is safe even if From is a Choice[], a LitSeq[] or an Option[_] Quite slow, slower than nodalExtract
- Inherited from:
- FHIRObject
- Inherited from:
- Utils
- Inherited from:
- Utils
- Inherited from:
- FHIRObject
- Inherited from:
- FHIRObject
Convenience alias for nodalGetByClass andThen map to LitSeq[To] using fn: From => To.
Convenience alias for nodalGetByClass andThen map to LitSeq[To] using fn: From => To.
- Inherited from:
- FHIRObject
Extract values of type From Unlike nodalMap, this is safe even if From is a Choice[_], a LitSeq[_] or an Option[_], however there remains a caveat with 'subtyped' types (eg PositiveInt), in that we can't differentiate them from the parent class Quite slow but faster than ^^
Extract values of type From Unlike nodalMap, this is safe even if From is a Choice[_], a LitSeq[_] or an Option[_], however there remains a caveat with 'subtyped' types (eg PositiveInt), in that we can't differentiate them from the parent class Quite slow but faster than ^^
- Inherited from:
- FHIRObject
Bit faster than >>
, but still much slower than using update$foo
when possible. If you must use it, then:
Bit faster than >>
, but still much slower than using update$foo
when possible. If you must use it, then:
T
should not be a Choice[_], a LitSeq[_], an Option[_], or any 'subtyped' type (eg PositiveInt). You should ensure, if T is a supertype of multiple valid choice values (e.g. T =:= Object), that the return value of fn retains the same type as the input value.
- Inherited from:
- FHIRObject
- Inherited from:
- FHIRObject
- Inherited from:
- FHIRObject
- Inherited from:
- FHIRObject
- Inherited from:
- FHIRObject
- Inherited from:
- FHIRObject