Health Protection Electronic Notification (HPEN)
Domain Message Specification

ITK Implementation

Application RolesResponsible for sendingResponsible for receiving
Health Protection Electronic Notification (HPEN) Originating System - usually a General Practitioner (POCD_AR000022GB01)
Public Health England (POCD_AR000023GB01)

Trigger Events

Health Protection Electronic Notification (HPEN) (POCD_TE000022GB01)

The Health Protection Electronic Notification (HPEN) trigger event indicates that a notifiable disease has been diagnosed, and a HPEN is ready to send to Public Health England.

Health Protection Electronic Notification (HPEN) Nullify By Replacement (POCD_TE000024GB01)

For the Health Protection Electronic Notification (HPEN) document to be nullified the trigger event is the realisation that the Health Protection Electronic Notification (HPEN) document was sent in error, in that it contained an error and should never have been sent and that no correct Health Protection Electronic Notification (HPEN) document is available to send.

Health Protection Electronic Notification (HPEN) Response (POCD_TE000023GB01)

The Health Protection Electronic Notification (HPEN) Response trigger event indicates that a Health Protection Electronic Notification Response document from Public Health England is ready to send.

Health Protection Electronic Notification (HPEN) Response Nullify By Replacement (POCD_TE000025GB01)

For the Health Protection Electronic Notification (HPEN) Response document to be nullified the trigger event is the realisation that the Health Protection Electronic Notification (HPEN) document was sent in error, in that it contained an error and should never have been sent and that no correct Health Protection Electronic Notification (HPEN) document is available to send.

Interactions

Health Protection Electronic Notification (HPEN) Interactions

Note : A Business Acknowledgement is only returned on receipt of a message where the received Distribution Envelope has a handlingSpecification with a key of “urn:nhs-itk:ns:201005:ackrequested” and a value of “true”.



Primary Recipient HPEN Document (urn:nhs-itk:interaction:primaryRecipientHPENDocument-v1-0)  

Communicates a Health Protection Electronic Notification (HPEN) to a primary recipient (i.e. Public Health England) where the recipient is recommended to act upon information carried in the document.

Note: This interaction has a message format that is constrained using HSCIC templates. This format is validated using a two level process. There are two sets of schema one for each level. The sender of this interaction must build all instances to the "on the wire" format using the generic CDA definition indicated in the wire format below. These instances must also conform to the rules stated in the conformance definition indicated in the conformance format below. The second level of validation requires transformation before schema validation can take place. For full details of this validation process please see the "Technical Guidance for Templated CDA Domains" section under the associated specifications tab.


Sender: Health Protection Electronic Notification (HPEN) Originating System - usually a General Practitioner (POCD_AR000022GB01)
Receiver: Public Health England (POCD_AR000023GB01)
Message: Trigger Event: Health Protection Electronic Notification (HPEN) (POCD_TE000022GB01)
Transmission Wrapper: ITK Distribution Envelope (Version 2.0) (distributionEnvelope-v2-0)
Web Service Wrapper: Send CDA Document (Version 2.0) (Input) (SendCDADocument-v2-0 (CoreServices-v1-0.wsdl))
Nullify HPEN Document (urn:nhs-itk:interaction:nullifyHPENDocument-v1-0)  

Communicates the nullification (by replacement) of any Health Protection Electronic Notification (HPEN) sent to any recipient. Must be sent to all information recipients (including copy recipients).

Note: This interaction has a message format that is constrained using HSCIC templates. This format is validated using a two level process. There are two sets of schema one for each level. The sender of this interaction must build all instances to the "on the wire" format using the generic CDA definition indicated in the wire format below. These instances must also conform to the rules stated in the conformance definition indicated in the conformance format below. The second level of validation requires transformation before schema validation can take place. For full details of this validation process please see the "Technical Guidance for Templated CDA Domains" section under the associated specifications tab.


Sender: Health Protection Electronic Notification (HPEN) Originating System - usually a General Practitioner (POCD_AR000022GB01)
Receiver: Public Health England (POCD_AR000023GB01)
Message: Trigger Event: Health Protection Electronic Notification (HPEN) Nullify By Replacement (POCD_TE000024GB01)
Transmission Wrapper: ITK Distribution Envelope (Version 2.0) (distributionEnvelope-v2-0)
Web Service Wrapper: Send CDA Document (Version 2.0) (Input) (SendCDADocument-v2-0 (CoreServices-v1-0.wsdl))

Health Protection Electronic Notification (HPEN) Response Interactions

Note : A Business Acknowledgement is only returned on receipt of a message where the received Distribution Envelope has a handlingSpecification with a key of “urn:nhs-itk:ns:201005:ackrequested” and a value of “true”.



Primary Recipient HPEN Response (urn:nhs-itk:interaction:primaryRecipientHPENResponse-v1-0)  

Communicates a Health Protection Electronic Notification (HPEN) Response to a primary recipient (i.e. a GP or GP Practice that sent thh HPEN) where the recipient is recommended to act upon information carried in the document.

Note: This interaction has a message format that is constrained using HSCIC templates. This format is validated using a two level process. There are two sets of schema one for each level. The sender of this interaction must build all instances to the "on the wire" format using the generic CDA definition indicated in the wire format below. These instances must also conform to the rules stated in the conformance definition indicated in the conformance format below. The second level of validation requires transformation before schema validation can take place. For full details of this validation process please see the "Technical Guidance for Templated CDA Domains" section under the associated specifications tab.


Sender: Public Health England (POCD_AR000023GB01)
Receiver: Health Protection Electronic Notification (HPEN) Originating System - usually a General Practitioner (POCD_AR000022GB01)
Message: Trigger Event: Health Protection Electronic Notification (HPEN) Response (POCD_TE000023GB01)
Transmission Wrapper: ITK Distribution Envelope (Version 2.0) (distributionEnvelope-v2-0)
Web Service Wrapper: Send CDA Document (Version 2.0) (Input) (SendCDADocument-v2-0 (CoreServices-v1-0.wsdl))
Nullify HPEN Response (urn:nhs-itk:interaction:nullifyHPENResponse-v1-0)  

Communicates the nullification (by replacement) of any Health Protection Electronic Notification (HPEN) Response sent to any recipient. Must be sent to all information recipients (including copy recipients).

Note: This interaction has a message format that is constrained using HSCIC templates. This format is validated using a two level process. There are two sets of schema one for each level. The sender of this interaction must build all instances to the "on the wire" format using the generic CDA definition indicated in the wire format below. These instances must also conform to the rules stated in the conformance definition indicated in the conformance format below. The second level of validation requires transformation before schema validation can take place. For full details of this validation process please see the "Technical Guidance for Templated CDA Domains" section under the associated specifications tab.


Sender: Public Health England (POCD_AR000023GB01)
Receiver: Health Protection Electronic Notification (HPEN) Originating System - usually a General Practitioner (POCD_AR000022GB01)
Message: Trigger Event: Health Protection Electronic Notification (HPEN) Response Nullify By Replacement (POCD_TE000025GB01)
Transmission Wrapper: ITK Distribution Envelope (Version 2.0) (distributionEnvelope-v2-0)
Web Service Wrapper: Send CDA Document (Version 2.0) (Input) (SendCDADocument-v2-0 (CoreServices-v1-0.wsdl))