Skip to main content


class HS.FHIR.DTL.vR4.Model.Resource.Composition extends HS.FHIR.DTL.vR4.Model.Base.DomainResource

A set of resources composed into a single coherent clinical statement with clinical attestation.

Property Inventory


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.
parameter XMLTYPE = Composition;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type.

The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.


property attester as list of HS.FHIR.DTL.vR4.Model.Element.Composition.attester (XMLNAME = "attester", XMLPROJECTION = "ELEMENT");

Attests to accuracy of composition.

Property methods: attesterBuildValueArray(), attesterCollectionToDisplay(), attesterCollectionToOdbc(), attesterDisplayToCollection(), attesterGet(), attesterGetObject(), attesterGetObjectId(), attesterGetSwizzled(), attesterIsValid(), attesterOdbcToCollection(), attesterSet(), attesterSetObject(), attesterSetObjectId()
property author as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "author", XMLPROJECTION = "ELEMENT") [ Required ];

Who and/or what authored the composition.

Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization

Property methods: authorBuildValueArray(), authorCollectionToDisplay(), authorCollectionToOdbc(), authorDisplayToCollection(), authorGet(), authorGetObject(), authorGetObjectId(), authorGetSwizzled(), authorIsValid(), authorOdbcToCollection(), authorSet(), authorSetObject(), authorSetObjectId()
property category as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "category", XMLPROJECTION = "ELEMENT");

Categorization of Composition.

any FHIR4 code may be used; document-classcodes shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: categoryBuildValueArray(), categoryCollectionToDisplay(), categoryCollectionToOdbc(), categoryDisplayToCollection(), categoryGet(), categoryGetObject(), categoryGetObjectId(), categoryGetSwizzled(), categoryIsValid(), categoryOdbcToCollection(), categorySet(), categorySetObject(), categorySetObjectId()
property confidentiality as %String (MAXLEN = 1000000, XMLNAME = "confidentiality", XMLPROJECTION = "ATTRIBUTE");

As defined by affinity domain.

v3-ConfidentialityClassification|2014-03-26 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend v3-ConfidentialityClassification|2014-03-26 and you may NOT use codes from other ValueSets.

Property methods: confidentialityDisplayToLogical(), confidentialityGet(), confidentialityIsValid(), confidentialityLogicalToDisplay(), confidentialityLogicalToOdbc(), confidentialityNormalize(), confidentialitySet()
property custodian as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "custodian", XMLPROJECTION = "ELEMENT");

Organization which maintains the composition.


Property methods: custodianGet(), custodianGetSwizzled(), custodianIsValid(), custodianNewObject(), custodianSet()
property date as %String (MAXLEN = 1000000, XMLNAME = "date", XMLPROJECTION = "ATTRIBUTE") [ Required ];

Composition editing time.

Property methods: dateDisplayToLogical(), dateGet(), dateIsValid(), dateLogicalToDisplay(), dateLogicalToOdbc(), dateNormalize(), dateSet()
property encounter as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "encounter", XMLPROJECTION = "ELEMENT");

Context of the Composition.


Property methods: encounterGet(), encounterGetSwizzled(), encounterIsValid(), encounterNewObject(), encounterSet()
property event as list of HS.FHIR.DTL.vR4.Model.Element.Composition.event (XMLNAME = "event", XMLPROJECTION = "ELEMENT");

The clinical service(s) being documented.

Property methods: eventBuildValueArray(), eventCollectionToDisplay(), eventCollectionToOdbc(), eventDisplayToCollection(), eventGet(), eventGetObject(), eventGetObjectId(), eventGetSwizzled(), eventIsValid(), eventOdbcToCollection(), eventSet(), eventSetObject(), eventSetObjectId()
property identifier as HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");

Version-independent identifier for the Composition.

Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property relatesTo as list of HS.FHIR.DTL.vR4.Model.Element.Composition.relatesTo (XMLNAME = "relatesTo", XMLPROJECTION = "ELEMENT");

Relationships to other compositions/documents.

Property methods: relatesToBuildValueArray(), relatesToCollectionToDisplay(), relatesToCollectionToOdbc(), relatesToDisplayToCollection(), relatesToGet(), relatesToGetObject(), relatesToGetObjectId(), relatesToGetSwizzled(), relatesToIsValid(), relatesToOdbcToCollection(), relatesToSet(), relatesToSetObject(), relatesToSetObjectId()
property section as list of HS.FHIR.DTL.vR4.Model.Element.Composition.section (XMLNAME = "section", XMLPROJECTION = "ELEMENT");

Composition is broken into sections.

Property methods: sectionBuildValueArray(), sectionCollectionToDisplay(), sectionCollectionToOdbc(), sectionDisplayToCollection(), sectionGet(), sectionGetObject(), sectionGetObjectId(), sectionGetSwizzled(), sectionIsValid(), sectionOdbcToCollection(), sectionSet(), sectionSetObject(), sectionSetObjectId()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];

preliminary | final | amended | entered-in-error

composition-status|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend composition-status|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property subject as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "subject", XMLPROJECTION = "ELEMENT");

Who and/or what the composition is about.

Any FHIR4 Resource may be indicated by this Reference

Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()
property title as %String (MAXLEN = 1000000, XMLNAME = "title", XMLPROJECTION = "ATTRIBUTE") [ Required ];

Human Readable name/title.

Property methods: titleDisplayToLogical(), titleGet(), titleIsValid(), titleLogicalToDisplay(), titleLogicalToOdbc(), titleNormalize(), titleSet()
property type as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "type", XMLPROJECTION = "ELEMENT") [ Required ];

Kind of composition (LOINC if possible)

doc-typecodes is the PREFERRED FHIR4 ValueSet for codes, but if you need to express meanings not found in doc-typecodes, you may use codes from any ValueSet.

Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab