Skip to main content

HS.FHIRModel.R4.DocumentManifest

class HS.FHIRModel.R4.DocumentManifest extends HS.FHIRModel.FHIRClassSuper

*****************************************
** DocumentManifest generated class schema
*****************************************
A collection of documents compiled for a purpose together with metadata that applies to the collection.

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_DOCUMENTMANIFEST;
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.

Properties

property _created as HS.FHIRModel.R4.Element;
Extensions for created
Property methods: _createdGet(), _createdGetSwizzled(), _createdIsValid(), _createdNewObject(), _createdSet()
property _description as HS.FHIRModel.R4.Element;
Extensions for description
Property methods: _descriptionGet(), _descriptionGetSwizzled(), _descriptionIsValid(), _descriptionNewObject(), _descriptionSet()
property _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property _source as HS.FHIRModel.R4.Element;
Extensions for source
Property methods: _sourceGet(), _sourceGetSwizzled(), _sourceIsValid(), _sourceNewObject(), _sourceSet()
property _status as HS.FHIRModel.R4.Element;
Extensions for status
Property methods: _statusGet(), _statusGetSwizzled(), _statusIsValid(), _statusNewObject(), _statusSet()
property author as HS.FHIRModel.R4.SeqOfReference;
Identifies who is the author of the manifest. Manifest author is not necessarly the author of the references included.
Property methods: authorGet(), authorGetSwizzled(), authorIsValid(), authorNewObject(), authorSet()
property contained as HS.FHIRModel.R4.SeqOfResourceList;
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.
Property methods: containedGet(), containedGetSwizzled(), containedIsValid(), containedNewObject(), containedSet()
property content as HS.FHIRModel.R4.SeqOfReference [ Required ];
The list of Resources that consist of the parts of this manifest.
Property methods: contentGet(), contentGetSwizzled(), contentIsValid(), contentNewObject(), contentSet()
property created as %String;
When the document manifest was created for submission to the server (not necessarily the same thing as the actual resource last modified time, since it may be modified, replicated, etc.).
Property methods: createdDisplayToLogical(), createdGet(), createdIsValid(), createdLogicalToDisplay(), createdLogicalToOdbc(), createdNormalize(), createdSet()
property description as %String;
Human-readable description of the source document. This is sometimes known as the "title".
Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
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.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property identifier as HS.FHIRModel.R4.SeqOfIdentifier;
Other identifiers associated with the document manifest, including version independent identifiers.
Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property implicitRules as %String;
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.
Property methods: implicitRulesDisplayToLogical(), implicitRulesGet(), implicitRulesIsValid(), implicitRulesLogicalToDisplay(), implicitRulesLogicalToOdbc(), implicitRulesNormalize(), implicitRulesSet()
property language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
property masterIdentifier as HS.FHIRModel.R4.Identifier;
A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts.
Property methods: masterIdentifierGet(), masterIdentifierGetSwizzled(), masterIdentifierIsValid(), masterIdentifierNewObject(), masterIdentifierSet()
property meta as HS.FHIRModel.R4.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.
Property methods: metaGet(), metaGetSwizzled(), metaIsValid(), metaNewObject(), metaSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
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).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
property recipient as HS.FHIRModel.R4.SeqOfReference;
A patient, practitioner, or organization for which this set of documents is intended.
Property methods: recipientGet(), recipientGetSwizzled(), recipientIsValid(), recipientNewObject(), recipientSet()
Related identifiers or resources associated with the DocumentManifest.
Property methods: relatedGet(), relatedGetSwizzled(), relatedIsValid(), relatedNewObject(), relatedSet()
property resourceType as %String [ InitialExpression = "DocumentManifest" , Required ];
This is a DocumentManifest resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property source as %String;
Identifies the source system, application, or software that produced the document manifest.
Property methods: sourceDisplayToLogical(), sourceGet(), sourceIsValid(), sourceLogicalToDisplay(), sourceLogicalToOdbc(), sourceNormalize(), sourceSet()
property status as %String (VALUELIST = ",current,superseded,entered-in-error");
The status of this document manifest.
Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property subject as HS.FHIRModel.R4.Reference;
Who or what the set of documents is about. The documents 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 farm animals, or a set of patients that share a common exposure). If the documents cross more than one subject, then more than one subject is allowed here (unusual use case).
Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()
property text as HS.FHIRModel.R4.Narrative;
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.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()
The code specifying the type of clinical activity that resulted in placing the associated content into the DocumentManifest.
Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()

Methods

method IncludeAuthor()
method IncludeContained()
method IncludeContent()
method IncludeExtension()
method IncludeIdentifier()
method IncludeMasterIdentifier()
method IncludeMeta()
method IncludeModifierExtension()
method IncludeRecipient()
method IncludeRelated()
method IncludeSubject()
method IncludeText()
method IncludeType()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class in the definition order that they were discovered in the the HL7FHIR JSchema document
method toDao() as %DynamicAbstractObject
Inherited description: >

The toDao() method casts the set to a DAO.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab