Skip to main content

HS.FHIRModel.R4.DocumentReference

class HS.FHIRModel.R4.DocumentReference extends HS.FHIRModel.FHIRClassSuper

*****************************************
** DocumentReference generated class schema
*****************************************
A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_DOCUMENTREFERENCE;
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 _date as HS.FHIRModel.R4.Element;
Extensions for date
Property methods: _dateGet(), _dateGetSwizzled(), _dateIsValid(), _dateNewObject(), _dateSet()
property _description as HS.FHIRModel.R4.Element;
Extensions for description
Property methods: _descriptionGet(), _descriptionGetSwizzled(), _descriptionIsValid(), _descriptionNewObject(), _descriptionSet()
property _docStatus as HS.FHIRModel.R4.Element;
Extensions for docStatus
Property methods: _docStatusGet(), _docStatusGetSwizzled(), _docStatusIsValid(), _docStatusNewObject(), _docStatusSet()
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 _status as HS.FHIRModel.R4.Element;
Extensions for status
Property methods: _statusGet(), _statusGetSwizzled(), _statusIsValid(), _statusNewObject(), _statusSet()
property authenticator as HS.FHIRModel.R4.Reference;
Which person or organization authenticates that this document is valid.
Property methods: authenticatorGet(), authenticatorGetSwizzled(), authenticatorIsValid(), authenticatorNewObject(), authenticatorSet()
property author as HS.FHIRModel.R4.SeqOfReference;
Identifies who is responsible for adding the information to the document.
Property methods: authorGet(), authorGetSwizzled(), authorIsValid(), authorNewObject(), authorSet()
property category as HS.FHIRModel.R4.SeqOfCodeableConcept;
A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.
Property methods: categoryGet(), categoryGetSwizzled(), categoryIsValid(), categoryNewObject(), categorySet()
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.DocumentReferenceX.SeqOfDocumentReferenceXContent [ Required ];
The document and format referenced. There may be multiple content element repetitions, each with a different format.
Property methods: contentGet(), contentGetSwizzled(), contentIsValid(), contentNewObject(), contentSet()
The clinical context in which the document was prepared.
Property methods: contextGet(), contextGetSwizzled(), contextIsValid(), contextNewObject(), contextSet()
property custodian as HS.FHIRModel.R4.Reference;
Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.
Property methods: custodianGet(), custodianGetSwizzled(), custodianIsValid(), custodianNewObject(), custodianSet()
property date as %String;
When the document reference was created.
Property methods: dateDisplayToLogical(), dateGet(), dateIsValid(), dateLogicalToDisplay(), dateLogicalToOdbc(), dateNormalize(), dateSet()
property description as %String;
Human-readable description of the source document.
Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property docStatus as %String;
The status of the underlying document.
Property methods: docStatusDisplayToLogical(), docStatusGet(), docStatusIsValid(), docStatusLogicalToDisplay(), docStatusLogicalToOdbc(), docStatusNormalize(), docStatusSet()
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, 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;
Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document.
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()
Relationships that this document has with other document references that already exist.
Property methods: relatesToGet(), relatesToGetSwizzled(), relatesToIsValid(), relatesToNewObject(), relatesToSet()
property resourceType as %String [ InitialExpression = "DocumentReference" , Required ];
This is a DocumentReference resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property securityLabel as HS.FHIRModel.R4.SeqOfCodeableConcept;
A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the "reference" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to.
Property methods: securityLabelGet(), securityLabelGetSwizzled(), securityLabelIsValid(), securityLabelNewObject(), securityLabelSet()
property status as %String (VALUELIST = ",current,superseded,entered-in-error");
The status of this document reference.
Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property subject as HS.FHIRModel.R4.Reference;
Who or what the document is about. The document 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 farm animals, or a set of patients that share a common exposure).
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()
Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.
Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()

Methods

method IncludeAuthenticator()
method IncludeAuthor()
method IncludeCategory()
method IncludeContained()
method IncludeContent()
method IncludeContext()
method IncludeCustodian()
method IncludeExtension()
method IncludeIdentifier()
method IncludeMasterIdentifier()
method IncludeMeta()
method IncludeModifierExtension()
method IncludeRelatesTo()
method IncludeSecurityLabel()
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