dt_vocab_EhrRequestAckCode : public <<enumeration>> class
Created: 06/01/07 15:38:15
Modified: 06/01/07 15:38:15
Project:
Advanced:

Assigned OID : 2.16.840.1.113883.2.1.3.2.4.17.101

Use of the codes


Positive Responses

When constructing a positive response to a received GP2GP Message no numeric error code is used, however the typeCode is used as follows:

<acknowledgement typeCode = "AA">

In this case the ControlActEvent will not contain a 'reason' element

Negative Responses

When constructing a negative response to a received GP2GP Message the table of numeric codes in section 3 are available for use.
Here the Acknowledgement.typeCode is used as follows:

<acknowledgement typeCode = "AE">

In addition the ControlActEvent.reason should be populated as follows (using the relevant code from the table, as highlighted in blue below):

Attribute Details
public String
  03
<<enum>>
Initial: "Record available but cannot be sent"
collection=false
containment=Not Specified
derived=0
description= Deprecated Code : This should be used in cases where the activity of sending failed for technical reasons.
duplicates=0
lowerBound=1
ordered=0
position=0
stereotype=enum
styleex=volatile=0;
type=String
upperBound=1
Notes: <br /> <br /> <br /> Deprecated Code <br /> : This should be used in cases where the activity of sending failed for technical reasons. <br />
public String
  04
<<enum>>
Initial: "record unavailable"
collection=false
containment=Not Specified
derived=0
description= Deprecated Code : This should be used when the record is not available for viewing by the requester. Most likely this will be as a result of the requester having no LR with the target patient, or the req
duplicates=0
lowerBound=1
ordered=0
position=0
stereotype=enum
styleex=volatile=0;
type=String
upperBound=1
Notes: <br /> <br /> <br /> Deprecated Code <br /> : This should be used when the record is not available for viewing by the requester. Most likely this will be as a result of the requester having no LR with the target patient, or the requester not being registered as the healthCareProvider in PDS. <br />
public String
  05
<<enum>>
Initial: "Record lost"
collection=false
containment=Not Specified
derived=0
description= Deprecated Code : This should be used when the patient is identified on the local index, but the record cannot be located on the system.
duplicates=0
lowerBound=1
ordered=0
position=0
stereotype=enum
styleex=volatile=0;
type=String
upperBound=1
Notes: <br /> <br /> <br /> Deprecated Code <br /> : This should be used when the patient is identified on the local index, but the record cannot be located on the system. <br />
public String
  06
<<enum>>
Initial: "Patient not at surgery"
collection=false
containment=Not Specified
derived=0
description= This should be used when the patient, identified by the NHS Number in the EHR Request, cannot be located in the local index of the receiving system.
duplicates=0
lowerBound=1
ordered=0
position=0
stereotype=enum
styleex=volatile=0;
type=String
upperBound=1
Notes: <br /> This should be used when the patient, identified by the NHS Number in the EHR Request, cannot be located in the local index of the receiving system. <br />
public String
  07
<<enum>>
Initial: "GP2GP Messaging is not enabled on this system"
collection=false
containment=Not Specified
derived=0
description= This should be used when a GP2GP message is received whilst the system is configured in the 'Disabled' mode.
duplicates=0
lowerBound=1
ordered=0
position=0
stereotype=enum
styleex=volatile=0;
type=String
upperBound=1
Notes: <br /> This should be used when a GP2GP message is received whilst the system is configured in the 'Disabled' mode. <br />
public String
  08
<<enum>>
Initial: "The system's configuration prevents it from processing this message."
collection=false
containment=Not Specified
derived=0
description= This should be used when a GP2GP message is received whilst the 'Safe Exchange Framework' is enabled, and the received message breaks the processing rules.
duplicates=0
lowerBound=1
ordered=0
position=0
stereotype=enum
styleex=volatile=0;
type=String
upperBound=1
Notes: <br /> This should be used when a GP2GP message is received whilst the 'Safe Exchange Framework' is enabled, and the received message breaks the processing rules. <br />
public String
  09
<<enum>>
Initial: "EHR Extract received without corresponding request."
collection=false
containment=Not Specified
derived=0
description= This should be used when a GP2GP EHR Extract message is received by a system that has not previously sent an EHR Request message.
duplicates=0
lowerBound=1
ordered=0
position=0
stereotype=enum
styleex=volatile=0;
type=String
upperBound=1
Notes: <br /> This should be used when a GP2GP EHR Extract message is received by a system that has not previously sent an EHR Request message. <br />
public String
  10
<<enum>>
Initial: "Failed to successfully generate EHR Extract."
collection=false
containment=Not Specified
derived=0
description= This should be used when a system fails to generate the EHR Extract for sending.
duplicates=0
lowerBound=1
ordered=0
position=0
stereotype=enum
styleex=volatile=0;
type=String
upperBound=1
Notes: <br /> This should be used when a system fails to generate the EHR Extract for sending. <br />
public String
  11
<<enum>>
Initial: "Failed to successfully integrate EHR Extract."
collection=false
containment=Not Specified
derived=0
description= This should be used when a system fails to successfully integrate the received EHR Extract into the clinical system.
duplicates=0
lowerBound=1
ordered=0
position=0
stereotype=enum
styleex=volatile=0;
type=String
upperBound=1
Notes: <br /> This should be used when a system fails to successfully integrate the received EHR Extract into the clinical system. <br />
public String
  12
<<enum>>
Initial: "Duplicate EHR Extract received."
collection=false
containment=Not Specified
derived=0
description= This should be used when a system receives a subsequent copy of an EHR Extract after it has previously integrated one for the current registration.
duplicates=0
lowerBound=1
ordered=0
position=0
stereotype=enum
styleex=volatile=0;
type=String
upperBound=1
Notes: <br /> This should be used when a system receives a subsequent copy of an EHR Extract after it has previously integrated one for the current registration. <br />
public String
  99
<<enum>>
Initial: "Unexpected condition."
collection=false
containment=Not Specified
derived=0
description= This is a code that should only be used in circumstances where the above codes cannot be used to accurately describe the condition.
duplicates=0
lowerBound=1
ordered=0
position=0
stereotype=enum
styleex=volatile=0;
type=String
upperBound=1
Notes: <br /> This is a code that should only be used in circumstances where the above codes cannot be used to accurately describe the condition. <br />
Tag Value Details
complexity 1  
documentation Assigned OID : 2.16.840.1.113883.2.1.3.2.4.17.101 Use of the codes Positive Responses When constructing a positive response to a received GP2GP Message no numeric error code is used, however the typeCode  
ea_ntype 0  
ea_stype Class  
gentype Java  
isSpecification false  
package Vocabulary  
package_name C+M Vocab sets  
phase 1.0  
status active  
stereotype enumeration  
tagged 0  
version 2.0