Data Model Libraries
    Preparing search index...

    Class Composition

    Composition Class

    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.).

    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.

    FHIR Specification

    • Short: 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 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.).
    • Comment: While the focus of this specification is on patient-specific clinical statements, this resource can also apply to other healthcare-related statements such as study protocol designs, healthcare invoices and other activities that are not necessarily patient-specific or clinical.
    • FHIR Version: 5.0.0

    FHIR Composition

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    url? identifier? version? compositionStatusEnum status type_ category? subject? encounter? date useContext? author name? title note? attester? custodian? relatesTo? event? section?

    Methods

    parse getUrlElement setUrlElement hasUrlElement getUrl setUrl hasUrl getIdentifier setIdentifier addIdentifier hasIdentifier getVersionElement setVersionElement hasVersionElement getVersion setVersion hasVersion getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getType setType hasType getCategory setCategory addCategory hasCategory getSubject setSubject addSubject hasSubject getEncounter setEncounter hasEncounter getDateElement setDateElement hasDateElement getDate setDate hasDate getUseContext setUseContext addUseContext hasUseContext getAuthor setAuthor addAuthor hasAuthor getNameElement setNameElement hasNameElement getName setName hasName getTitleElement setTitleElement hasTitleElement getTitle setTitle hasTitle getNote setNote addNote hasNote getAttester setAttester addAttester hasAttester getCustodian setCustodian hasCustodian getRelatesTo setRelatesTo addRelatesTo hasRelatesTo getEvent setEvent addEvent hasEvent getSection setSection addSection hasSection fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initCategory initSubject initUseContext initAuthor initNote initAttester initRelatesTo initEvent initSection

    Constructors

    Properties

    url?: UriType

    Composition.url Element

    FHIR Specification

    • Short: Canonical identifier for this Composition, represented as a URI (globally unique)
    • Definition: An absolute URI that is used to identify this Composition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this Composition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the Composition is stored on different servers.
    • Comment: Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
    • Requirements: Allows the Composition to be referenced by a single globally unique identifier.
    • FHIR Type: uri
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    identifier?: Identifier[]

    Composition.identifier Element

    FHIR Specification

    • Short: Version-independent identifier for the Composition
    • Definition: A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time.
    • Comment: Similar to ClinicalDocument/setId in CDA. See discussion in resource definition for how these relate.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    version?: StringType

    Composition.version Element

    FHIR Specification

    • Short: An explicitly assigned identifer of a variation of the content in the Composition
    • Definition: An explicitly assigned identifer of a variation of the content in the Composition.
    • Comment: While each resource, including the composition itself, has its own version identifier, this is a formal identifier for the logical version of the Composition as a whole. It would remain constant if the resources were moved to a new server, and all got new individual resource versions, for example.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    compositionStatusEnum: CompositionStatusEnum

    FHIR CodeSystem: CompositionStatus

    CompositionStatusEnum

    status: null | EnumCodeType

    Composition.status Element

    FHIR Specification

    • Short: registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
    • Definition: The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.
    • Comment: If a composition is marked as withdrawn, the compositions/documents in the series, or data from the composition or document series, should never be displayed to a user without being clearly marked as untrustworthy. The flag "entered-in-error" is why this element is labeled as a modifier of other elements. Some reporting work flows require that the original narrative of a final document never be altered; instead, only new narrative can be added. The composition resource has no explicit status for explicitly noting whether this business rule is in effect. This would be handled by an extension if required.
    • Requirements: Need to be able to mark interim, amended, or withdrawn compositions or documents.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    • isSummary: true

    CodeSystem Enumeration: CompositionStatusEnum

    Privatetype_

    type_: null | CodeableConcept

    Composition.type Element

    FHIR Specification

    • Short: 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.
    • Comment: For Composition type, LOINC is ubiquitous and strongly endorsed by HL7. Most implementation guides will require a specific LOINC code, or use LOINC as an extensible binding.
    • Requirements: Key metadata element describing the composition, used in searching/filtering.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    category?: CodeableConcept[]

    Composition.category Element

    FHIR Specification

    • Short: Categorization of Composition
    • 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.
    • Requirements: Helps humans to assess whether the composition is of interest when viewing an index of compositions or documents.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    subject?: Reference[]

    Composition.subject Element

    FHIR Specification

    • Short: 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 (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).
    • Comment: For clinical documents, this is usually the patient.
    • Requirements: Essential metadata for searching for the composition. Identifies who and/or what the composition/document is about.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    encounter?: Reference

    Composition.encounter Element

    FHIR Specification

    • Short: Context of the Composition
    • Definition: Describes the clinical encounter or type of care this documentation is associated with.
    • Requirements: Provides context for the composition and supports searching.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    date: null | DateTimeType

    Composition.date Element

    FHIR Specification

    • Short: Composition editing time
    • Definition: The composition editing time, when the composition was last logically changed by the author.
    • Comment: The Last Modified Date on the composition may be after the date of the document was attested without being changed. This means that the date on an amended document is the date of the amendment, not the date of original authorship.
    • Requirements: dateTime is used for tracking, organizing versions and searching. Note that this is the time of authoring this version of the Composition. When packaged in a document, Bundle.timestamp is the date of packaging.
    • FHIR Type: dateTime
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    useContext?: UsageContext[]

    Composition.useContext Element

    FHIR Specification

    • Short: The context that the content is intended to support
    • Definition: The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate Composition instances.
    • Comment: When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
    • Requirements: Assist in searching for appropriate content.
    • FHIR Type: UsageContext
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    author: null | Reference[]

    Composition.author Element

    FHIR Specification

    name?: StringType

    Composition.name Element

    FHIR Specification

    • Short: Name for this Composition (computer friendly)
    • Definition: A natural language name identifying the {{title}}. This name should be usable as an identifier for the module by machine processing applications such as code generation.
    • Comment: The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.
    • Requirements: Support human navigation and code generation.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    title: null | StringType

    Composition.title Element

    FHIR Specification

    • Short: Human Readable name/title
    • Definition: Official human-readable label for the composition.
    • Comment: For many compositions, the title is the same as the text or a display name of Composition.type (e.g. a "consultation" or "progress note"). Note that CDA does not make title mandatory, but there are no known cases where it is useful for title to be omitted, so it is mandatory here. Feedback on this requirement is welcome during the trial use period.
    • FHIR Type: string
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    note?: Annotation[]

    Composition.note Element

    FHIR Specification

    • Short: For any additional notes
    • Definition: For any additional notes.
    • Comment: A comment, general note or annotation not coded elsewhere.
    • FHIR Type: Annotation
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    attester?: CompositionAttesterComponent[]

    Composition.attester Element

    FHIR Specification

    • Short: Attests to accuracy of composition
    • Definition: A participant who has attested to the accuracy of the composition/document.
    • Comment: Only list each attester once.
    • Requirements: Identifies responsibility for the accuracy of the composition content.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    custodian?: Reference

    Composition.custodian Element

    FHIR Specification

    • Short: Organization which maintains the composition
    • Definition: Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.
    • Comment: This is useful when documents are derived from a composition - provides guidance for how to get the latest version of the document. This is optional because this is sometimes not known by the authoring system, and can be inferred by context. However, it is important that this information be known when working with a derived document, so providing a custodian is encouraged.
    • Requirements: Identifies where to go to find the current version, where to report issues, etc.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    relatesTo?: RelatedArtifact[]

    Composition.relatesTo Element

    FHIR Specification

    • Short: Relationships to other compositions/documents
    • Definition: Relationships that this composition has with other compositions or documents that already exist.
    • Comment: To reference (using relatesTo) a Bundle of type "document" or another Composition where you only have the identifier, use a resourceReference with an identifier.\ When a Composition is an alternate representation of another type of document e.g. CDA, the other document could be referenced in a DocumentReference resource. Here is an example of using relatesTo to reference another Bundle of type "document" or Composition where you only have the identifier: "relatesTo": [{ "type": "replaces", "resourceReference": { "identifier": { "system": "...", "value": "..." } } }]
    • FHIR Type: RelatedArtifact
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    event?: CompositionEventComponent[]

    Composition.event Element

    FHIR Specification

    • Short: The clinical service(s) being documented
    • Definition: The clinical service, such as a colonoscopy or an appendectomy, being documented.
    • Comment: The event needs to be consistent with the type element, though can provide further information if desired.
    • Requirements: Provides context for the composition and creates a linkage between a resource describing an event and the composition created describing the event.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    section?: CompositionSectionComponent[]

    Composition.section Element

    FHIR Specification

    • Short: Composition is broken into sections
    • Definition: The root of the sections that make up the composition.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided Composition JSON to instantiate the Composition data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR Composition

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to Composition

      Returns undefined | Composition

      Composition data model or undefined for Composition

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Reference array value to the author property.

      Parameters

      • value: undefined | null | Reference[]

        the author array value

      Returns this

      this

      @ReferenceTargets('Composition.author', ['Practitioner','PractitionerRole','Device','Patient','RelatedPerson','Organization',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetUrlElementsetUrlElementhasUrlElementgetUrlsetUrlhasUrlgetIdentifiersetIdentifieraddIdentifierhasIdentifiergetVersionElementsetVersionElementhasVersionElementgetVersionsetVersionhasVersiongetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetTypesetTypehasTypegetCategorysetCategoryaddCategoryhasCategorygetSubjectsetSubjectaddSubjecthasSubjectgetEncountersetEncounterhasEncountergetDateElementsetDateElementhasDateElementgetDatesetDatehasDategetUseContextsetUseContextaddUseContexthasUseContextgetAuthorsetAuthoraddAuthorhasAuthorgetNameElementsetNameElementhasNameElementgetNamesetNamehasNamegetTitleElementsetTitleElementhasTitleElementgetTitlesetTitlehasTitlegetNotesetNoteaddNotehasNotegetAttestersetAttesteraddAttesterhasAttestergetCustodiansetCustodianhasCustodiangetRelatesTosetRelatesToaddRelatesTohasRelatesTogetEventsetEventaddEventhasEventgetSectionsetSectionaddSectionhasSectionfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitCategoryinitSubjectinitUseContextinitAuthorinitNoteinitAttesterinitRelatesToinitEventinitSection