Skip to main content

HS.FHIR.DTL.vR4.Model.Resource.List

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

A list is a curated collection of resources.

Property 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 = List;
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 XMLPROJECTION = ELEMENT;
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 = List;
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 code as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "code", XMLPROJECTION = "ELEMENT");
CodeableConcept

What the purpose of this list is.

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

Property methods: codeGet(), codeGetSwizzled(), codeIsValid(), codeNewObject(), codeSet()
property date as %String (MAXLEN = 1000000, XMLNAME = "date", XMLPROJECTION = "ATTRIBUTE");
dateTime

When the list was prepared.

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

Why list is empty.

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

Property methods: emptyReasonGet(), emptyReasonGetSwizzled(), emptyReasonIsValid(), emptyReasonNewObject(), emptyReasonSet()
property encounter as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "encounter", XMLPROJECTION = "ELEMENT");
Reference

Context in which list created.

Encounter

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

Entries in the list.

Property methods: entryBuildValueArray(), entryCollectionToDisplay(), entryCollectionToOdbc(), entryDisplayToCollection(), entryGet(), entryGetObject(), entryGetObjectId(), entryGetSwizzled(), entryIsValid(), entryOdbcToCollection(), entrySet(), entrySetObject(), entrySetObjectId()
property identifier as list of HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifier

Business identifier.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property mode as %String (MAXLEN = 1000000, XMLNAME = "mode", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

working | snapshot | changes

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

Property methods: modeDisplayToLogical(), modeGet(), modeIsValid(), modeLogicalToDisplay(), modeLogicalToOdbc(), modeNormalize(), modeSet()
property note as list of HS.FHIR.DTL.vR4.Model.Datatype.Annotation (XMLNAME = "note", XMLPROJECTION = "ELEMENT");
Annotation

Comments about the list.

Property methods: noteBuildValueArray(), noteCollectionToDisplay(), noteCollectionToOdbc(), noteDisplayToCollection(), noteGet(), noteGetObject(), noteGetObjectId(), noteGetSwizzled(), noteIsValid(), noteOdbcToCollection(), noteSet(), noteSetObject(), noteSetObjectId()
property orderedBy as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "orderedBy", XMLPROJECTION = "ELEMENT");
CodeableConcept

What order the list has.

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

Property methods: orderedByGet(), orderedByGetSwizzled(), orderedByIsValid(), orderedByNewObject(), orderedBySet()
property source as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "source", XMLPROJECTION = "ELEMENT");
Reference

Who and/or what defined the list contents (aka Author)

Practitioner | PractitionerRole | Patient | Device

Property methods: sourceGet(), sourceGetSwizzled(), sourceIsValid(), sourceNewObject(), sourceSet()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

current | retired | entered-in-error

list-status|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend list-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");
Reference

If all resources have the same subject.

Patient | Group | Device | Location

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

Descriptive name for the list.

Property methods: titleDisplayToLogical(), titleGet(), titleIsValid(), titleLogicalToDisplay(), titleLogicalToOdbc(), titleNormalize(), titleSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab