Skip to main content

HS.FHIR.vSTU3.Model.Resource.Composition

deprecated class HS.FHIR.vSTU3.Model.Resource.Composition extends HS.FHIR.vSTU3.Model.Base.DomainResource

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
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.
If the element is present, it must have either a @value, an @id, or extensions

Property Inventory

Method Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute. NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.
parameter XMLNAME = Composition;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.

Properties

property attester as list of HS.FHIR.vSTU3.Model.Resource.Composition.Attester (XMLNAME = "attester", XMLPROJECTION = "ELEMENT");
A participant who has attested to the accuracy of the composition/document.
Property methods: attesterBuildValueArray(), attesterCollectionToDisplay(), attesterCollectionToOdbc(), attesterDisplayToCollection(), attesterGet(), attesterGetObject(), attesterGetObjectId(), attesterGetSwizzled(), attesterIsValid(), attesterOdbcToCollection(), attesterSet(), attesterSetObject(), attesterSetObjectId()
property author as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "author", XMLPROJECTION = "ELEMENT");
Identifies who is responsible for the information in the composition, not necessarily who typed it in.
Property methods: authorBuildValueArray(), authorCollectionToDisplay(), authorCollectionToOdbc(), authorDisplayToCollection(), authorGet(), authorGetObject(), authorGetObjectId(), authorGetSwizzled(), authorIsValid(), authorOdbcToCollection(), authorSet(), authorSetObject(), authorSetObjectId()
property class as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "class", XMLPROJECTION = "ELEMENT");
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.
Property methods: classGet(), classGetSwizzled(), classIsValid(), classNewObject(), classSet()
property confidentiality as HS.FHIR.vSTU3.Model.Base.ConfidentialityClassification (XMLNAME = "confidentiality", XMLPROJECTION = "ELEMENT");
The code specifying the level of confidentiality of the Composition.
Property methods: confidentialityGet(), confidentialityGetSwizzled(), confidentialityIsValid(), confidentialityNewObject(), confidentialitySet()
property custodian as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "custodian", XMLPROJECTION = "ELEMENT");
Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.
Property methods: custodianGet(), custodianGetSwizzled(), custodianIsValid(), custodianNewObject(), custodianSet()
property date as HS.FHIR.vSTU3.Model.Datatype.DateTime (XMLNAME = "date", XMLPROJECTION = "ELEMENT") [ Required ];
The composition editing time, when the composition was last logically changed by the author.
Property methods: dateGet(), dateGetSwizzled(), dateIsValid(), dateNewObject(), dateSet()
property encounter as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "encounter", XMLPROJECTION = "ELEMENT");
Describes the clinical encounter or type of care this documentation is associated with.
Property methods: encounterGet(), encounterGetSwizzled(), encounterIsValid(), encounterNewObject(), encounterSet()
property event as list of HS.FHIR.vSTU3.Model.Resource.Composition.Event (XMLNAME = "event", XMLPROJECTION = "ELEMENT");
The clinical service, such as a colonoscopy or an appendectomy, being documented.
Property methods: eventBuildValueArray(), eventCollectionToDisplay(), eventCollectionToOdbc(), eventDisplayToCollection(), eventGet(), eventGetObject(), eventGetObjectId(), eventGetSwizzled(), eventIsValid(), eventOdbcToCollection(), eventSet(), eventSetObject(), eventSetObjectId()
property identifier as HS.FHIR.vSTU3.Model.Base.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Logical identifier for the composition, assigned when created. This identifier stays constant as the composition is changed over time.
Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property relatesTo as list of HS.FHIR.vSTU3.Model.Resource.Composition.RelatesTo (XMLNAME = "relatesTo", XMLPROJECTION = "ELEMENT");
Relationships that this composition has with other compositions or documents that already exist.
Property methods: relatesToBuildValueArray(), relatesToCollectionToDisplay(), relatesToCollectionToOdbc(), relatesToDisplayToCollection(), relatesToGet(), relatesToGetObject(), relatesToGetObjectId(), relatesToGetSwizzled(), relatesToIsValid(), relatesToOdbcToCollection(), relatesToSet(), relatesToSetObject(), relatesToSetObjectId()
property section as list of HS.FHIR.vSTU3.Model.Resource.Composition.Section (XMLNAME = "section", XMLPROJECTION = "ELEMENT");
The root of the sections that make up the composition.
Property methods: sectionBuildValueArray(), sectionCollectionToDisplay(), sectionCollectionToOdbc(), sectionDisplayToCollection(), sectionGet(), sectionGetObject(), sectionGetObjectId(), sectionGetSwizzled(), sectionIsValid(), sectionOdbcToCollection(), sectionSet(), sectionSetObject(), sectionSetObjectId()
property status as HS.FHIR.vSTU3.Model.Base.CompositionStatus (XMLNAME = "status", XMLPROJECTION = "ELEMENT") [ Required ];
The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.
Property methods: statusGet(), statusGetSwizzled(), statusIsValid(), statusNewObject(), statusSet()
property subject as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "subject", XMLPROJECTION = "ELEMENT") [ Required ];
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).
Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()
property title as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "title", XMLPROJECTION = "ELEMENT") [ Required ];
Official human-readable label for the composition.
Property methods: titleGet(), titleGetSwizzled(), titleIsValid(), titleNewObject(), titleSet()
property type as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "type", XMLPROJECTION = "ELEMENT") [ Required ];
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.
Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()

Methods

deprecated method SetAuthor(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "author" property.
deprecated method SetClass(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "class" property.
deprecated method SetConfidentiality(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "confidentiality" property.
deprecated method SetCustodian(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "custodian" property.
deprecated method SetDate(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "date" property.
deprecated method SetEncounter(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "encounter" property.
deprecated method SetIdentifier(pValue As %String = "", pSystem As %String = "", pUse As %String = "", pTypeCode As %String = "", pTypeSystem As %String = "", pTypeDisplay As %String = "", pTypeText As %String = "", pId As %String = "", pStart As %String = "", pEnd As %String = "", pAssignerReference As %String = "", pAssignerDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "identifier" property.
deprecated method SetStatus(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "status" property.
deprecated method SetSubject(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "subject" property.
deprecated method SetTitle(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "title" property.
deprecated method SetType(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "type" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab