HS.FHIRModel.R4.Endpoint
class HS.FHIRModel.R4.Endpoint extends HS.FHIRModel.FHIRClassSuper
******************************************* Endpoint generated class schema
*****************************************
The technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b or a REST endpoint for another FHIR server. This may include any security context information.
Property Inventory
- _address
- _header
- _implicitRules
- _language
- _name
- _payloadMimeType
- _status
- address
- connectionType
- contact
- contained
- extension
- fhirID
- header
- identifier
- implicitRules
- language
- managingOrganization
- meta
- modifierExtension
- name
- payloadMimeType
- payloadType
- period
- resourceType
- status
- text
Method Inventory
- IncludeConnectionType()
- IncludeContact()
- IncludeContained()
- IncludeExtension()
- IncludeHeader()
- IncludeIdentifier()
- IncludeManagingOrganization()
- IncludeMeta()
- IncludeModifierExtension()
- IncludePayloadMimeType()
- IncludePayloadType()
- IncludePeriod()
- IncludeText()
- _getProperties()
- fromDao()
- toDao()
Parameters
parameter XMLTYPE = R4_ENDPOINT;
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 _address as HS.FHIRModel.R4.Element;
Extensions for address
Property methods: _addressGet(), _addressGetSwizzled(), _addressIsValid(), _addressNewObject(), _addressSet()
property _header as HS.FHIRModel.R4.SeqOfElement;
Extensions for header
Property methods: _headerGet(), _headerGetSwizzled(), _headerIsValid(), _headerNewObject(), _headerSet()
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 _name as HS.FHIRModel.R4.Element;
Extensions for name
Property methods: _nameGet(), _nameGetSwizzled(), _nameIsValid(), _nameNewObject(), _nameSet()
property _payloadMimeType as HS.FHIRModel.R4.SeqOfElement;
Extensions for payloadMimeType
Property methods: _payloadMimeTypeGet(), _payloadMimeTypeGetSwizzled(), _payloadMimeTypeIsValid(), _payloadMimeTypeNewObject(), _payloadMimeTypeSet()
property _status as HS.FHIRModel.R4.Element;
Extensions for status
Property methods: _statusGet(), _statusGetSwizzled(), _statusIsValid(), _statusNewObject(), _statusSet()
property address as %String;
The uri that describes the actual end-point to connect to.
Property methods: addressDisplayToLogical(), addressGet(), addressIsValid(), addressLogicalToDisplay(), addressLogicalToOdbc(), addressNormalize(), addressSet()
property connectionType as HS.FHIRModel.R4.Coding [ Required ];
A coded value that represents the technical details of the usage
of this endpoint, such as what WSDLs should be used in what way.
(e.g. XDS.b/DICOM/cds-hook).
Property methods: connectionTypeGet(), connectionTypeGetSwizzled(), connectionTypeIsValid(), connectionTypeNewObject(), connectionTypeSet()
property contact as HS.FHIRModel.R4.SeqOfContactPoint;
Contact details for a human to contact about the subscription. The
primary use of this for system administrator troubleshooting.
Property methods: contactGet(), contactGetSwizzled(), contactIsValid(), contactNewObject(), contactSet()
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 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 header as HS.FHIRModel.R4.SeqOfString;
Additional headers / information to send as part of the notification.
Property methods: headerGet(), headerGetSwizzled(), headerIsValid(), headerNewObject(), headerSet()
property identifier as HS.FHIRModel.R4.SeqOfIdentifier;
Identifier for the organization that is used to identify the endpoint
across multiple disparate systems.
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 managingOrganization as HS.FHIRModel.R4.Reference;
The organization that manages this endpoint (even if technically
another organization is hosting this in the cloud, it is the organization
associated with the data).
Property methods: managingOrganizationGet(), managingOrganizationGetSwizzled(), managingOrganizationIsValid(), managingOrganizationNewObject(), managingOrganizationSet()
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 name as %String;
A friendly name that this endpoint can be referred to with.
Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property payloadMimeType as HS.FHIRModel.R4.SeqOfString;
The mime type to send the payload in - e.g. application/fhir+xml,
application/fhir+json. If the mime type is not specified, then the
sender could send any content (including no content depending on
the connectionType).
Property methods: payloadMimeTypeGet(), payloadMimeTypeGetSwizzled(), payloadMimeTypeIsValid(), payloadMimeTypeNewObject(), payloadMimeTypeSet()
property payloadType as HS.FHIRModel.R4.SeqOfCodeableConcept [ Required ];
The payload type describes the acceptable content that can be communicated
on the endpoint.
Property methods: payloadTypeGet(), payloadTypeGetSwizzled(), payloadTypeIsValid(), payloadTypeNewObject(), payloadTypeSet()
property period as HS.FHIRModel.R4.Period;
The interval during which the endpoint is expected to be operational.
Property methods: periodGet(), periodGetSwizzled(), periodIsValid(), periodNewObject(), periodSet()
property resourceType as %String [ InitialExpression = "Endpoint" , Required ];
This is a Endpoint resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property status as %String (VALUELIST = ",active,suspended,error,off,entered-in-error,test");
active | suspended | error | off | test.
Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
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()
Methods
method IncludeConnectionType()
method IncludeContact()
method IncludeContained()
method IncludeExtension()
method IncludeHeader()
method IncludeIdentifier()
method IncludeManagingOrganization()
method IncludeMeta()
method IncludeModifierExtension()
method IncludePayloadMimeType()
method IncludePayloadType()
method IncludePeriod()
method IncludeText()
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
classmethod fromDao(dao As %Library.DynamicAbstractObject) as HS.FHIRModel.R4.Endpoint
method toDao() as %DynamicAbstractObject
Inherited description: >
The toDao() method casts the set to a DAO.
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
- add()
- addAll()
- apply()
- clear()
- contains()
- containsAll()
- get()
- iterator()
- put()
- putAll()
- putAllIfAbsent()
- putIfAbsent()
- remove()
- removeAll()
- removeIf()
- rename()
- replace()
- replaceAll()
- size()
- toString()