.biceps-model.6.0.0.source-code.BICEPS_MessageModel.xsd Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of biceps-model Show documentation
Show all versions of biceps-model Show documentation
SDCri is a set of Java libraries that implements a network communication framework conforming
with the IEEE 11073 SDC specifications. This project implements the model for
IEEE 11073-10207.
The newest version!
This XML schema defines the 'Basic Integrated Clinical Environment Protocol Specification' (BICEPS) that is a Domain Information Model (DIM) for point of care medical device communication.
It encompasses the device model and the corresponding messages.
This XML Schema is based on the ISO/IEEE 11073-10201 Domain Information Model standard,
which belongs to the "Point-of-care medical device communication" standard family in ISO/IEEE 11073.
This standard family should not to be confused with the ISO/IEEE 11073 "Personal Health Device" standard family.
While former is based on the standards ISO/IEEE 11073-10101, 11073-10201, 11073-20101, and 11073-30200,
the latter is based on ISO/IEEE 11073-20601 and ISO/IEEE 11073-104xx.
The Domain Information model is subdivided into two parts, a static part (referred to as Descriptor)
that provides general information about the hardware specification of the elements and
a dynamic part (referred to as State) that may change during time.
TransactionId is a transaction identifier that SHALL be unique among an operation invocation transaction.
Transaction state of an invoked operation.
Wait = Waiting. The operation has been queued and waits for execution.
Start = Started. The execution of the operation has been started.
Cnclld = Cancelled. The execution has been cancelled by the SERVICE PROVIDER.
CnclldMan = Cancelled Manually. The execution has been cancelled by the operator.
Fin = Finished. The execution has been finished.
FinMod = Finished with modification. As the requested target value could not be reached, the next best value has been chosen and used as target value.
The execution has been failed.
InvocationError conveys details with respect to the origin of an operation invocation failure.
Unspec = Unspecified. An unspecified error has occurred. No more information about the error is available.
Unkn = Unknown Operation. The HANDLE to the operation object is not known.
Inv = Invalid Value. The HANDLE to the operation object does not match the invocation request MESSAGE.
Example: if a msg:SetString MESSAGE is received, in which the msg:SetString/msg:OperationHandleRef points to a msg:SetValue MESSAGE, the receiver replies with InvocationError "Inv".
Oth = Other. Another type of error has occurred. More information on the error MAY be available.
InvocationInfo conveys information to describe a transaction operation.
Transaction identifier that has been assigned to the processing of a set operation.
The transaction identifier SHALL be used to identify a set operation transaction status that is delivered via msg:OperationInvokedReport MESSAGEs. The transaction's initial identifier is tramsmitted in the response of a set operation request.
Processing state of an invoked operation.
If ./msg:InvocationState indicates a failure, InvocationError may convey more information about the error.
If ./msg:InvocationState indicates a failure, InvocationErrorMessage may convey a MESSAGE for a user with information about the error.
The GET SERVICE provides a set of request and response MESSAGEs. AbstractGet is the building block for any GET SERVICE request MESSAGE.
The GET SERVICE provides a set of request and response MESSAGEs. AbstractGetResponse is the building block for any GET SERVICE response MESSAGE.
Per convention any response MESSAGE ends up with "Response", whereas request MESSAGEs possess no specific suffix.
Any report that is delivered using msg:AbstractReport MAY consist of multiple report parts. AbstractReport is the building block for a single report part in a msg:AbstractReport.
Reference to the MDS that has triggered the sending of the report part. An event sink MAY use this HANDLE reference for filtering.
- If the MDIB includes a single MDS only, SourceMds is OPTIONAL.
- If the MDIB includes multiple MDSs, SourceMds is REQUIRED.
Event report services provide a set of MESSAGEs, which are distributed using a publish subscribe mechanism. AbstractReport is the building block for any event MESSAGE that is delivered to an event sink.
The SET SERVICE provides a set of request and response MESSAGEs. AbstractSet is the building block for any SET SERVICE request MESSAGE.
Handle of the set operation to invoke.
A SERVICE PROVIDER SHALL accept a set request only if at least the operation target HANDLE is valid and the operation is enabled according to the POC MEDICAL DEVICE's MDIB. A target HANDLE is valid if the operation to invoke can be applied on the object referenced by the target HANDLE. An operation can be considered as enabled if pm:AbstractOperationStateType/@OperatingMode equals "En".
The SET SERVICE provides a set of request and response MESSAGEs. AbstractSetResponse is the building block for any SET SERVICE response MESSAGE.
Per convention any response MESSAGE ends up with "Response", whereas request MESSAGEs possess no specific suffix.
Information set regarding the returned transaction. See pm:InvocationInfo.
GetMdib is the request to a msg:GetMdibResponse MESSAGE.
GetMdibResponse is the response to a msg:GetMdib MESSAGE It conveys the complete MDIB.
Since contexts might include privacy-related information, a SERVICE PROVIDER MAY decide to leave the MDS contexts empty. To acquire context information, a client has to send a msg:GetContextStates request.
Current snapshot of the MDIB.
GetMdDescription is the request to a msg:GetMdDescriptionResponse MESSAGE.
List of HANDLEs that specify which descriptors are requested. See msg:GetMdDescriptionResponse/msg:MdDescription.
GetMdDescriptionResponse is the response to a msg:GetMdDescription MESSAGE. It transports a set of MDS descriptors.
MdDescription comprises the requested set of MDS descriptors. Which MDS descriptors SHALL be included depends on the msg:GetMdDescription/msg:HandleRef list:
- If the HANDLE reference list is empty, all MDS descriptors are included in the result list.
- If a HANDLE reference does match an MDS descriptor, it is included in the result list.
- If a HANDLE reference does not match an MDS descriptor (i.e., any other descriptor), the MDS descriptor that is in the parent tree of the HANDLE reference is included in the result list.
GetMdState is the request to a msg:GetMdStateResponse MESSAGE.
List of HANDLEs that specify which states are requested. See msg:GetMdStateResponse/msg:MdState.
GetMdStateResponse is the response to a msg:GetMdState MESSAGE.
MdState comprises the requested set of MDS states. Which MDS states SHALL be included depends on the msg:GetMdState/msg:HandleRef list:
- If the HANDLE reference list is empty, all states in the MDIB are included in the result list.
- If a HANDLE reference does match a multi state HANDLE, the corresponding multi state is included in the result list.
- If a HANDLE reference does match a descriptor HANDLE, all states that belong to the corresponding descriptor are included in the result list.
Since context states might include privacy-related information, a SERVICE PROVIDER can decide to skip any contexts states. Context states have to be requested by sending a msg:GetContextStates request.
GetContextStates is the request to a msg:GetContextStatesResponse MESSAGE.
List of HANDLEs that specify which context states are requested. See msg:GetContextStatesResponse/msg:ContextState.
GetContextStatesResponse is the response to a msg:GetContextStates MESSAGE.
ContextState comprises the requested set of context states.
__R5039: If the msg:GetContextStates/msg:HandleRef list is empty, all context states in the MDIB SHALL be included in the result list.__
__R5040: If a HANDLE reference from the msg:GetContextStates/msg:HandleRef list does match a context descriptor HANDLE, then all context states that belong to the corresponding context descriptor SHALL be included in the result list.__
__R5041: If a HANDLE reference from the msg:GetContextStates/msg:HandleRef list does match a context state HANDLE, then the corresponding context state SHALL be included in the result list.__
__R5042: If a HANDLE reference from the msg:GetContextStates/msg:HandleRef list does match an MDS descriptor, then all context states that are part of this MDS SHALL be included in the result list.__
GetContextStatesByIdentification is the request to a msg:GetContextStatesByIdentificationResponse MESSAGE.
List of pm:InstanceIdentifier ELEMENTs that specify which context states are requested based on their pm:AbstractContextState/pm:Identification. See msg:GetContextStatesByIdentificationResponse/msg:ContextState.
ContextType defines the type of context to return (e.g., pm:LocationContextState or pm:PatientContextState).
GetContextStatesByIdentificationResponse is the response to a msg:GetContextStatesByIdentification MESSAGE.
ContextState comprises the requested set of context states.
__R5036: If the msg:GetContextStates/msg:Identification list is empty, then no context states SHALL be included in the result list.__
__R5037: The result list SHALL enclose all context states of the requested msg:GetContextStates/@ContextType that match at least all ELEMENTs from the msg:GetContextStates/msg:Identification list.__
GetContextStatesByFilter is the request to a msg:GetContextStatesByFilterResponse.
List of XPath expressions that specify which context states are requested based on XPath expressions. See msg:GetContextStatesByFilterResponse/msg:ContextState.
__R5045: The root node of the XPath expression SHALL be the pm:MdState ELEMENT of the target MDIB.__
ContextType defines the type of context to return (e.g., pm:LocationContextState or pm:PatientContextState).
GetContextStatesByFilterResponse is the response to a msg:GetContextStatesByFilter MESSAGE.
ContextState comprises the requested set of context states.
__R5043: If the msg:GetContextStates/msg:Filter list is empty, then no context states SHALL be included in the result list.__
__R5044: The result SHALL enclose all context states of the requested msg:GetContextStates/@ContextType that match the filter criteria from the msg:GetContextStates/msg:Filter list where all filter criteria are concatenated by a logical "and".__
NOTE—For a logical "or" concatenation a SERVICE CONSUMER has to send multiple requests. This is similar to the Types and Scopes filtering mechanism of WS-Discovery [WS-Discovery].
SetContextState is the request to a msg:SetContextStateResponse MESSAGE. Its function is to insert a new or modify an existing context state.
The corresponding operation description is defined by pm:SetContextStateOperationDescriptor.
ProposedContextState comprises the context states that have to be inserted or updated:
- If ProposedContextState/@Handle is equal ProposedContextState/@DescriptorHandle, the proposed object SHOULD be created as a new context state.
- If ProposedContextState/@Handle is not equal ProposedContextState/@DescriptorHandle, the proposed object SHOULD be modified.
Response MESSAGE to a SetContextState request MESSAGE.
AbstractContextReport is a change report that contains updated pm:AbstractContextState instances.
List of report containers associated to one MDS.
List of changed pm:AbstractContextState instances.
PeriodicContextReport is an msg:AbstractContextReport that is delivered periodically.
EpisodicContextReport is an msg:AbstractContextReport that is delivered episodically. It is sent if at least one pm:AbstractContextState has changed. It SHALL contain only pm:AbstractContextState instances where at least one child ELEMENT or ATTRIBUTE have changed.
GetLocalizedText is the request to a msg:GetLocalizedTextResponse MESSAGE. Its intended use is to obtain a localized text that is referenced in the MDIB.
Zero or more reference names of the texts that are requested. The ELEMENT SHALL have the following impacts on the information conveyed in msg:GetLocalizedTextResponse/msg:Text:
- If there is no Ref ELEMENT given in the request MESSAGE, then all texts are returned in msg:GetLocalizedTextResponse/msg:Text.
- If there is at least one Ref ELEMENT given, then msg:GetLocalizedTextResponse/msg:Text contains all texts that match the Ref ELEMENTs of the msg:GetLocalizedText request MESSAGE.
Revision of the referenced text that is requested. The ELEMENT SHALL have the following impacts on the information conveyed in msg:GetLocalizedTextResponse/msg:Text:
- If the referenced text is not available in the specific version, then msg:GetLocalizedTextResponse/msg:Text is empty.
- If Version is not specified, then msg:GetLocalizedTextResponse contains the latest version of the text in msg:GetLocalizedTextResponse/msg:Text.
Zero or more language identifiers according to RFC 5646 (see http://tools.ietf.org/html/rfc5646) to get different translations of the requested text. The ELEMENT SHALL have the following impacts on the information conveyed in msg:GetLocalizedTextResponse/msg:Text:
- If there is no Lang ELEMENT given in the request MESSAGE, then all translations are returned in msg:GetLocalizedTextResponse/msg:Text.
- If there is at least one Lang ELEMENT given, then msg:GetLocalizedTextResponse/msg:Text contains translations in all languages matching the Lang ELEMENTs of the msg:GetLocalizedText request MESSAGE. If a text is not available in a specific language, the result for that specific language is omitted.
NOTE—A set of supported languages is retrievable using msg:GetSupportedLanguages.
Zero or more pm:LocalizedTextWidth itentifiers to filter for different text widths. The ELEMENT SHALL have the following impacts on the information conveyed in msg:GetLocalizedTextResponse/msg:Text:
- If there is no TextWidth ELEMENT given in the request MESSAGE, then all text widths are returned in msg:GetLocalizedTextResponse/msg:Text.
- If there is at least one TextWidth ELEMENT given, then msg:GetLocalizedTextResponse/msg:Text contains texts with all text widths matching the TextWidth ELEMENTs of the msg:GetLocalizedText request MESSAGE. Matching in this case means that the number of full width characters in the text is less or equal to the TextWidth ELEMENTs.
Zero or more numbers to filter for number of lines. The ELEMENT SHALL have the following impacts on the information conveyed in msg:GetLocalizedTextResponse/msg:Text:
- If there is no NumberOfLines ELEMENT given in the request MESSAGE, then all texts independent of the number of lines are returned in msg:GetLocalizedTextResponse/msg:Text.
- If there is at least one NumberOfLines ELEMENT given, msg:GetLocalizedTextResponse/msg:Text contains texts that match the number of lines defined by the NumberOfLines ELEMENTs of the msg:GetLocalizedText request MESSAGE. Matching in this case means that the number of lines in the text is less or equal to the NumberOfLines ELEMENTs.
GetLocalizedTextResponse is the response to a msg:GetLocalizedText MESSAGE.
A list of texts that SHALL contain a result according to the selection constituted by msg:GetLocalizedText/msg:Ref, msg:GetLocalizedText/msg:Version, and msg:GetLocalizedText/msg:Lang.
GetSupportedLanguages is the request to a msg:GetSupportedLanguagesResponse MESSAGE.
GetSupportedLanguagesResponse is the response to a msg:GetSupportedLanguagesResponse MESSAGE. A GetSupportedLanguagesResponse MESSAGE SHALL be send in answer to a GetSupportedLanguages request MESSAGE and contains all language identifiers available for referenced localized texts.
List of language identifiers available to request referenced localized texts. The format is given in accordance to RFC 5646 (see http://tools.ietf.org/html/rfc5646).
VersionFrame constitutes a version frame by defining ./@Start and ./@End, whereby ./@Start is REQUIRED to be lesser than or equal to ./@End.
The start version of the version frame.
The end version of the version frame.
TimeFrame constitutes a time frame by defining ./@Start and ./@End, whereby ./@Start is REQUIRED to be lesser than ./@End.
The start time of the time frame.
The end time of the time frame.
GetDescriptorsFromArchive is the request to a msg:GetDescriptorsFromArchiveResponse MESSAGE. Its intended use is used to request descriptors from the MDIB archive related to a specific descriptor version and/or time frame.
__R5015: GetDescriptorsFromArchive SHALL at least expect ./msg:DescriptorRevisions or ./msg:TimeFrame as a filter condition.__
__R5016: If both ./msg:DescriptorRevisions and ./msg:TimeFrame are given, the filter SHALL be applied by conjunction. If none are defined, the MESSAGE is invalid.__
DescriptorRevisions is a version-based filter. It designates the referenced descriptor version frame that is requested. By adding this optional ELEMENT to the request, msg:GetDescriptorsFromArchiveResponse SHALL only respond with descriptors that match this version frame.
TimeFrame defines a time-based filter. By adding this ELEMENT to the request, msg:GetDescriptorsFromArchiveResponse SHALL only respond with descriptors that matches this time frame.
A list of HANDLE references that serve as a filter for the response.
__R5017: If one or more HANDLE references are defined, msg:GetDescriptorsFromArchiveResponse SHALL respond only with descriptors that match these HANDLE references at the given revision and/or time frame.__
__R5018: If no HANDLE references are defined, msg:GetDescriptorsFromArchiveResponse SHALL respond with all descriptors at the given revision and/or time frame.__
GetDescriptorsFromArchiveResponse MESSAGE is sent as the response to a GetDescriptorsFromArchive request MESSAGE using the ARCHIVE SERVICE.
A list of descriptors. The descriptors SHALL match the time frame as well as the version and HANDLE references of the GetDescriptorsFromArchive request MESSAGE.
GetStatesFromArchive MESSAGE is used by the ARCHIVE SERVICE to request states related to a specific state version and/or time frame.
__R5019: GetStatesFromArchive SHALL at least expect a version or a time frame filter.__
__R5020: If both a version and a time frame are defined, the filter SHALL apply by conjunction. If none are defined, the MESSAGE is invalid.__
NOTE—It is not sufficient to provide HANDLEs only.
StateRevisions is a version filter. It designates the referenced state version frame that is requested. By adding this optional ELEMENT to the request, GetStatesFromArchiveResponse SHALL only respond with states matching this version frame.
TimeFrame defines a time-based filter. By adding this optional ELEMENT to the request, GetStatesFromArchiveResponse SHALL only respond with states matching this time frame.
A list of HANDLE references which serve as a filter for the response.
__R5021: If one or more HANDLE references are defined, GetStatesFromArchiveResponse SHALL respond only with states matching these HANDLE references at the given revision and/or time frame.__
__R5022: If no HANDLE references are defined, GetStatesFromArchiveResponse SHALL respond with all states at the given revision and/or time frame.__
__R5023: If a HANDLE is a descriptor HANDLE that points to a multi state, GetStatesFromArchiveResponse SHALL respond with all states referring to the descriptor HANDLE.__
GetStatesFromArchiveResponse MESSAGE is sent as the response to a GetStatesFromArchive request MESSAGE using the ARCHIVE SERVICE.
A list of states. The states SHALL match the time frame as well as the version and HANDLE references of the GetStatesFromArchive request MESSAGE.
SetValue is the request to a msg:SetValueResponse MESSAGE.
The corresponding operation description is defined by pm:SetValueOperationDescriptor.
Value of pm:NumericMetricState/pm:ObservedValue/@Value to set.
SetValueResponse is the response to a msg:SetValue MESSAGE.
SetString is the request to a msg:SetStringResponse MESSAGE.
The corresponding operation description is defined by pm:SetStringOperationDescriptor.
Value of pm:StringMetricState/pm:ObservedValue/@Value to set.
SetStringResponse is the response to a msg:SetString MESSAGE.
Activate is the request to an msg:ActivateResponse MESSAGE. It allows invocation of a predefined job, e.g., to silence alarms.
The corresponding operation description is defined by pm:ActivateOperationDescriptor.
List of arguments that can be used for invocation. The type list of the arguments can be obtained by the operation description in the MDIB. Furthermore, the ordering of Argument SHALL match the ordering in pm:ActivateOperationDescriptor/pm:Argument.
Argument value.
ActivateResponse is the response to an msg:Activate MESSAGE.
SetAlertState is the request to a msg:SetAlertStateResponse MESSAGE. The intended use is to modifiy alert states.
The corresponding operation description is defined by pm:SetAlertStateOperationDescriptor.
ProposedAlertState comprises the alert states that have to be updated.
SetAlertStateResponse is the response to a msg:SetAlertState MESSAGE.
SetComponentState is the request to a msg:SetComponentStateResponse MESSAGE. Its intended use is to modify an existing component state.
The corresponding operation description is defined by pm:SetComponentStateOperationDescriptor.
ProposedComponentState comprises the component states that have to be updated.
SetComponentStateResponse is the response to a msg:SetComponentState MESSAGE.
SetMetricState is the request to a msg:SetMetricStateResponse MESSAGE.
The corresponding operation description is defined by pm:SetMetricStateOperationDescriptor.
ProposedMetricState comprises the METRIC states that have to be updated.
SetMetricStateResponse is the response to a msg:SetMetricState MESSAGE.
OperationInvokedReport is a change report that contains updated invocation information. It is delivered if the state of the execution of a remote operation request has changed.
To identify which state of a multi state is changed or created, OperationInvokedReport SHALL include msg:OperationInvokedReportPart/@OperationTarget. This ATTRIBUTE defines the multi state that is created or updated.
List of report containers associated to one MDS.
Information set regarding the report's transaction status. See pm:InvocationInfo.
Identifies the PARTICIPANT that has requested the execution of the operation.
NOTE—If another PARTICIPANT is interested in who requested a certain operation, it is able to track that information by means of InvocationSource.
A REQUIRED HANDLE reference that provides a link to the set operation processed by the transaction.
An OPTIONAL HANDLE reference that provides a link to the CONTAINMENT TREE ENTRY affected by the transaction.
GetContainmentTree is the request to a msg:GetContainmentTreeResponse MESSAGE. It is intended to be used as a tool to navigate through the CONTAINMENT TREE of an MDIB.
List of HANDLE references that specify which CONTAINMENT TREE ENTRYs are requested.
__R5030: All HANDLE references SHALL share the same parent. Otherwise, the result of GetContainmentTree is undefined.__
GetContainmentTreeResponse is the response to a msg:GetContainmentTree MESSAGE.
ContainmentTreeInfo as described in pm:ContainmentTree.
__R5031: The result SHALL contain CONTAINMENT TREE information of all ELEMENTs that are matched by msg:GetContainmentTree/msg:HandleRef.__
__R5032: If no HANDLE reference is provided, all CONTAINMENT TREE ELEMENTs on MDS level SHALL be returned.__
GetDescriptor is the request to a msg:GetDescriptorResponse MESSAGE. It is proposed to be used to resolve the HANDLE references that are requested by msg:GetContainmentTree.
List of HANDLE references that specify which descriptors are requested.
GetDescriptorResponse is the response to a msg:GetDescriptorResponse MESSAGE.
List of pm:AbstractDescriptor ELEMENTs.
__R5033: Resulting descriptors SHALL NOT contain child descriptors.__
__R5034: The result SHALL contain CONTAINMENT TREE information of all descriptors that are matched by msg:GetDescriptor/msg:HandleRef.__
__R5035: If no HANDLE is provided, all descriptors SHALL be returned.__
AbstractMetricReport is a change report that contains updated pm:AbstractMetricState instances.
List of report containers associated to one MDS.
List of changed pm:AbstractMetricState instances.
EpisodicMetricReport is an msg::AbstractMetricReport that is delivered episodically. It is sent if at least one pm:AbstractMetricState has changed. It SHALL contain only pm:AbstractMetricState instances where at least one child ELEMENT or ATTRIBUTE have changed.
PeriodicMetricReport is an msg:AbstractMetricReport that is delivered periodically.
AbstractComponentReport is a change report that contains updated pm:AbstractComponentState instances.
List of report containers associated to one MDS.
List of changed pm:AbstractComponentState instances.
EpisodicComponentReport is an msg:AbstractComponentReport that is delivered episodically. It is sent if at least one pm:AbstractComponentState has changed. It SHALL contain only pm:AbstractComponentState instances where at least one child ELEMENT or ATTRIBUTE have changed.
PeriodicComponentReport is an msg:AbstractComponentReport that is delivered periodically.
AbstractAlertReport is a change report that contains updated pm:AbstractAlertState instances.
List of report containers associated to one MDS.
List of changed pm:AbstractAlertState instances.
EpisodicAlertReport is an msg:AbstractAlertReport that is delivered episodically. It is sent if at least one pm:AbstractAlertState has changed. It SHALL contain only pm:AbstractAlertState instances where at least one child ELEMENT or ATTRIBUTE have changed.
PeriodicAlertReport is an msg:AbstractAlertReport that is delivered periodically.
AbstractOperationalStateReport is a change report that contains updated pm:AbstractOperationState instances.
List of report containers associated to one MDS.
List of changed pm:AbstractOperationState instances.
EpisodicOperationalStateReport is an msg:AbstractOperationalStateReport that is delivered episodically. It is sent if at least one pm:AbstractOperationState has changed. It SHALL contain only pm:AbstractOperationState instances where at least one child ELEMENT or ATTRIBUTE have changed.
PeriodicOperationalStateReport is an msg:AbstractOperationalStateReport that is delivered periodically.
SystemErrorReport is an msg:AbstractReport. It is sent episodically when a system error has occurred.
List of report containers associated to one MDS. Every report part contains an error code plus an OPTIONAL, human-readable description.
CODED VALUE of the error.
Additional textual information. ErrorInfo SHALL NOT make use of the pm:LocalizedTextType/@Ref ATTRIBUTE.
DescriptionModificationType designates the modification mode when a msg:DescriptionModificationReport is sent.
Crt = Created. Indicates that the object transmitted by a modification MESSAGE has been created, i.e. inserted into the MDIB.
Upt = Updated. Indicates that the object transmitted by a modification MESSAGE has been updated.
Del = Deleted. Indicates that the object transmitted by a modification MESSAGE has been deleted, i.e. removed from the MDIB.
DescriptionModificationReport is an msg:AbstractReport that is delivered episodically. It is sent if at least one pm:AbstractDescriptor has changed. It SHALL contain only pm:AbstractDescriptor instances where at least one child ELEMENT or ATTRIBUTE have changed, i.e., inserted, updated, or deleted.
List of report containers associated to one MDS.
Descriptor that was inserted into, updated from or deleted from the MDIB. The mode is stored in the ./@ModificationType ATTRIBUTE.
__R5024: Descriptors in this list SHALL not include nested descriptors.__
NOTE—If nested descriptors are also modified, then they can be included as children of the report part.
__R5025: Updated descriptors SHALL be ordered in the way that parent descriptors appear before child descriptors.__
__R5046: If a parent descriptor is deleted, then all child descriptors of that parent SHALL communicated as deleted in advance.__
The descriptor's corresponding state(s).
__R5051: If ./@ModificationType is "Crt", then the descriptor version referenced by State SHALL match the descriptor given in ./Descriptor.__
__R5052: If ./@ModificationType is "Upt", then the descriptor version referenced by State SHALL match the descriptor given in ./Descriptor.__
__R5053: If ./@ModificationType is "Del", then State SHALL be omitted from the MESSAGE.__
The HANDLE reference of the parent descriptor. The HANDLE reference SHALL be empty if an pm:MdsDescriptor is inserted, updated or deleted.
Determines if the descriptor stored in ./msg:Descriptor has been inserted into, updated from or deleted from the MDIB. The implied value SHALL be "Upt".
The WaveformStream MESSAGE is sent in order to transmit a set of samples of one or more waveforms.
State represents a list of sample arrays of a waveform.
The ObservedValueStream MESSAGE is sent in order to transmit observed values of one or more waveforms. This object MAY be used for optimized waveform value transmission.
__R5026: If ObservedValueStream is supported, any changes to the observed value of pm:RealTimeSampleArrayMetricState SHALL be reported by ObservedValueStream while other changes are reported through pm:WaveformStream.__
A stream ELEMENT that contains observed values of a stream-able state.
Handle reference to the descriptor the observed values belong to.
Version number of the state. The implied value SHALL be "0".
The method on how it is retrieve the information about a state.
The CONTAINMENT TREE ENTRY is retrievable via a get request. Use the corresponding get MESSAGE.
Per = Periodic. The CONTAINMENT TREE ENTRY is retrievable via a periodic event report. Use the corresponding periodic event report MESSAGE (e.g., pm:PeriodicMetricReport).
Ep = Episodic. The CONTAINMENT TREE ENTRY is retrievable via an episodic event report. Use the corresponding episodic event report MESSAGE (e.g., pm:EpisodicMetricReport).
Strm = Stream. The CONTAINMENT TREE ENTRY is retrievable via a waveform stream. Use the msg:WaveformStream or msg:ObservedValueStream MESSAGE.
Retrievability provides information on how it is possible to access a state.
The method on how to retrieve a state.
The periodicity in which updates can be expected to be communicated as a periodic event. The implied value SHALL be "PT1S".
Extension point that SHOULD be included as a pm:AbstractMetricDescriptor extension to describe METRIC retrievability (see msg:RetrievabilityMethod). Since a METRIC might be retrievable by several methods, Retrievability comprises a list of msg:RetrievabilityInfo ELEMENTs.
Retrievability information set.