QueryResponse - tabular view

No Current Link To VocabularyCoded With ExtensionsCoded No Extensions
QUQI_RM030000UK03
ControlActEvent

The Query Response Control Act carries administrative information related to the query response in a query session.

This profile represents both a query response which is reporting an error and does not contain a domain payload and a successful query response which contains a domain payload response.

Used by:
[1..1] classCode (CS {CNE:CACT} ){ Fixed="CACT " }

Indicates that  this is a Control Act.

  • Fixed value "CACT"
[1..1] moodCode (CS {CNE:EVN} ){ Fixed="EVN " }

Indicates that the control act mood is an event.

  • Fixed value "EVN"
[0..1] author

A participation referring to a person who is logged in at the time the message is initiated. 

The participation is optional. It shall be present when the message is initiated by a person. It shall not be present when the message is automatically initiated by a system. 

[1..1] typeCode (CS {CNE:AUT} ){ Fixed="AUT " }

Indicates that the role has author responsibility.

  • Fixed value: "AUT"
[1..1] participant      [CMET: UKCT_MT120901UK01]

NPfIT CMET to identify a person fulfilling a specific role where the Person, Role Profile and Job Role are all mandatory. Full details of the person, role profile and job role are available from SDS.

In this context the person is the signed in user for the user session responsible for initiating the message. The person shall be identified by SDS Role Profile ID, SDS User Id and SDS Role Id.

[1..2] author1

A participation referring to one or more systems that are involved in the initiation of the message.

One instance of the participation is mandatory and shall carry the accredited service id of the system in use at the time the message is initiated.

One instance of the participation is optional and may carry the workstation id of the system being used by the logged in user at the time the message is initiated.

[1..1] typeCode (CS {CNE:AUT} ){ Fixed="AUT " }

Indicates that the role has author responsibility.

  • Fixed value: "AUT"
[1..1] participant      [CMET: UKCT_MT121001UK01]

NPfIT CMET to identify a mandatory system which could be software or hardware. Full details of the system are available from SDS.

In this context the system is a system in use at the time the message is initiated.This shall be represented by either the SDS Accredited Application Instance Id held in the SDS directory as the Accredited System Identifier or a locally identified workstation id.

[0..*] reason

Identifies the relationship between the control act and the detected issue event.

[1..1] typeCode (CS {CNE:RSON} ){ Fixed="RSON " }

Indicates that this is a reason.

  • Fixed value: "RSON"
[1..1] justifyingDetectedIssueEvent (DetectedIssueEvent)

Details of the detected issue.

[0..1] subject

Refers to the subject act of the message.

[1..1] typeCode (CS {CNE:SUBJ} ){ Fixed="SUBJ " }

Indicates that the domain payload entry point act is the subject of the Control Act. 

  • Fixed value: "SUBJ"
[1..1] act (Act)

The act that is the entry point into the domain payload

[1..1] queryAck (QueryAck)

Information related to a query response.

QueryAck

Information related to a query response.

Used by: ControlActEvent
[1..1] queryResponseCode (CS {CNE:QueryResponse} )

This allows the responding system to return a code that classifies the general nature of the query response.

The Coded Only datatype flavour is used to carry this information as follows:

  • The code attribute shall contain a value from the list of codes in the QueryResponse vocabulary.
DetectedIssueEvent

Details of the business issue or error that has been detected by the receiving system.

A business issue or error is defined as being one that is related to the information conveyed by the message evaluated in context by the processing application. 

Used by: ControlActEvent
[1..1] classCode (CS {CNE:ALRT} ){ Fixed="ALRT " }

Indicates that the act is an alert.

  • Fixed value: "ALRT"
[1..1] moodCode (CS {CNE:EVN} ){ Fixed="EVN " }

Indicates that this is an alert that has occurred.

  • Fixed value: "EVN".
[1..1] code (CD {CNE:ActDetectedIssueCode} )

This allows the responding system to record the business issue or error that has been detected.

All business issues and errors shall be reported using DetectedIssueEvent.code. The code shall contain a qualifier sub element to indicate the severity of the issue or error. 

The Coded Qualified datatype flavour shall be used to carry this information as follows:

  • The code attribute is required and shall contain a value from one of the code systems identified under ActDetectedIssueCode
  • The displayName attribute is optional and may contain the textual description of the code
  • The codeSystem attribute is required and shall contain an OID as appropriate.
  • The originalText sub element is optional and may contain the text used as the basis for the coding 
  • The qualifier sub element is required and  shall contain one of the qualifier codes identified under DetectedIssueQualifier together with the appropriate OID.
Act

This class provides the entry point into the domain payload.

Used by: ControlActEvent
[1..1] classCode (CS {CNE:ACT} ){ Fixed="ACT " }

Indicates that the entry point is an act.

  • Fixed value "ACT"
[1..1] moodCode (CS {CNE:ActMood} )

Indicates that the act that is the entry point has a mood.