#### Child Protection
Domain Message Specification

### CP-ISAccessToServiceNotification Tabular View

REPC_RM000004GB01 |
CP-ISAccessToServiceNotification | A message to return information relating to who has accessed the child protection data to the system which uploaded the data. This information is returned using the original query structure.
| Used by:
[1..1] [M] classCode (CS { CNE: ActClass } ) { Fixed="INFRM" } | Model Attribute Description The HL7 attribute classCode describes this class as an inform. Implementation in XML Instance The XML attribute classCode is fixed to "INFRM". Schema Constraint The attribute classCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.
[1..1] [M] moodCode (CS { CNE: ActMood } ) { Fixed="EVN" } | Model Attribute Description The HL7 attribute moodCode describes this class as inform event. Implementation in XML Instance The XML attribute moodCode is fixed to "EVN". Schema Constraint The attribute moodCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.
[1..1] [M] code (CV { CNE:CP-ISMessageType } ) { Fixed="05" } | Model Attribute Description The HL7 attribute code uses a code from the CP-ISMessageType vocabulary to describe this control act as a CP-IS access to service notification message. Implementation in XML Instance Coded Plain flavour of theCoded Value (CV) data type shall be used to carry this information in the XML element code as follows: The XML attribute code shall contain a fixed value of "05" The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.17.470" The XML attribute displayName shall carry the fixed value of "CP-IS Access to Service Notification" Schema Constraint The attribute code is prohibited in the schema and therefore does not appear in the "on the wire" instance. The attribute codeSystem is prohibited in the schema and therefore does not appear in the "on the wire" instance. The attribute displayName is prohibited in the schema and therefore does not appear in the "on the wire" instance.
[1..1] [M] effectiveTime (TS) | Model Attribute Description The HL7 attribute effectiveTime is used to define the time when the access to service information message was created. Implementation in XML Instance The XML attribute value of the XML element effectiveTime shall be populated with the time the access to service information message was created using a time stamp in the format yyyymmddhhmmss[+|-ZZzz] where: yyyy is the year mm is the month dd is the day hh is the hour mm is the minutes ss is the seconds [+|-ZZzz] is the time zone offset in hours and minutes
[1..1] [M] id (II) | Model Attribute Description The HL7 attribute id uses an identifier to identify each unique instance of the access to the service notification. Implementation in XML Instance The Identifier Global data type flavour is used to carry the identifier in the XML element id as follows: The XML attribute root shall contain the DCE UUID of the original query.
[1..1] [M] pertinentInformation | This class links the CP-IS Access to service notification class to the pertinent total returned records.
[1..1] [M] typeCode (CS { CNE: ActRelationshipType } ) { Fixed="PERT" } | Model Attribute Description The HL7 attribute typeCode uses a code to describe this class as pertinent information. Implementation in XML Instance The XML attribute typeCode is fixed to "PERT". Schema Constraint The attribute typeCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.
[1..1] [M] pertinentTotalReturnedRecords (TotalReturnedRecords) | A link to the total of returned records.
[0..*] pertinentInformation1 | This class links the CP-IS Access to service notification class to the pertinent CP-IS record access information.
[1..1] [M] typeCode (CS { CNE: ActRelationshipType } ) { Fixed="PERT" } | Model Attribute Description The HL7 attribute typeCode uses a code to describe this class as pertinent information. Implementation in XML Instance The XML attribute typeCode is fixed to "PERT". Schema Constraint The attribute typeCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.
[1..1] [R] pertinentCP-ISRecordAccess (CP-ISRecordAccess) | A link to the CP-IS record access information.
[1..1] [M] primaryInformationRecipient | This class details the primary recipient of the access to service information.
[1..1] [M] typeCode (CS { CNE: ParticipationType } ) { Fixed="PRCP" } | Model Attribute Description The HL7 attribute typeCode uses a code to describe this class as a primary information recipient participation. Implementation in XML Instance The XML attribute classCode is fixed to "PRCP". Schema Constraint The attribute typeCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.
[1..1] [M] contentId (II) { "NPFIT-100036#Role" } | Model Attribute Description The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use. The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at runtime with a value from the allowed list contained in the model. Implementation in XML Instance The Identifier External data type flavour is used to carry this information in the XML element contentId as follows: The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.16" The XML attribute extension shall contain one of the allowed template artefact identifiers.
[1..1] [M] participant (RecipientChoice) | A link to the choice of recipients.
RecipientChoice | The choice of recipients.
| Used by: CP-ISAccessToServiceNotification
[1..1] : Template1 |
TotalReturnedRecords | This class is the number of access records returned. This is the number of queries that were made against the total number of NHS numbers which resulted in access to the child protection information. Where no records were accessed this will contain the value zero.
| Used by: CP-ISAccessToServiceNotification
[1..1] [M] classCode (CS { CNE: ActClass } ) { Fixed="OBS" } | Model Attribute Description The HL7 attribute classCode describes this class as observation. Implementation in XML Instance The XML attribute classCode is fixed to "OBS". Schema Constraint The attribute classCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.
[1..1] [M] moodCode (CS { CNE: ActMood } ) { Fixed="EVN" } | Model Attribute Description The HL7 attribute moodCode describes this class as an observation event. Implementation in XML Instance The XML attribute moodCode is fixed to "EVN". Schema Constraint The attribute moodCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.
[1..1] [M] code (CV { CNE:CP-ISObservationType } ) { Fixed="TRR" } | Model Attribute Description The HL7 attribute code uses a code from the CP-ISObservationType vocabulary to describe this class a number of records returned observation. Implementation in XML Instance The Coded Plain flavour of theCoded Value (CV) data type shall be used to carry this information in the XML element code as follows: The XML attribute code shall contain a fixed value of "TRR" The XML attribute codeSystem shall contain a fixed value of "2.16.840.1.113883.2.1.3.2.4.17.469" The XML attribute displayName shall contain a fixed value of "Total Returned Records". Schema Constraint The attribute code is prohibited in the schema and therefore does not appear in the "on the wire" instance. The attribute codeSystem is prohibited in the schema and therefore does not appear in the "on the wire" instance. The attribute displayName is prohibited in the schema and therefore does not appear in the "on the wire" instance.
[1..1] [M] value (INT) | Model Attribute Description The HL7 attribute value is used to carry the number of accessed records contained in the file. If no records for this child have been accessed then the value of zero (0) will be returned. Implementation in XML Instance The XML element value should be populated as follows: The XML attribute value shall contain the total number of records.
CP-ISRecordAccess | This class is the CP-IS record access.
| Used by: CP-ISAccessToServiceNotification
[1..1] [M] classCode (CS { CNE: ActClass } ) { Fixed="INFRM" } | Model Attribute Description The HL7 attribute classCode describes this class as an inform. Implementation in XML Instance The XML attribute classCode is fixed to "INFRM". Schema Constraint The attribute classCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.
[1..1] [M] moodCode (CS { CNE: ActMood } ) { Fixed="EVN" } | Model Attribute Description The HL7 attribute moodCode describes this class as an inform event. Implementation in XML Instance The XML attribute moodCode is fixed to "EVN". Schema Constraint The attribute moodCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.
[1..1] [M] code (CV { CNE:CP-ISObservationType } ) { Fixed="CRA" } | Model Attribute Description The HL7 attribute code uses a code from the CP-ISObservationType vocabulary to describe this as a CP-IS record access Implementation in XML Instance The Coded Plain flavour of theCoded Value (CV) data type shall be used to carry this information in the XML element code as follows: The XML attribute code shall contain a fixed value of "CRA" The XML attribute codeSystem shall contain a fixed value of "2.16.840.1.113883.2.1.3.2.4.17.469" The XML attribute displayName shall contain a fixed value of "CP-IS Record Access" Schema Constraint The attribute code is prohibited in the schema and therefore does not appear in the "on the wire" instance. The attribute codeSystem is prohibited in the schema and therefore does not appear in the "on the wire" instance. The attribute displayName is prohibited in the schema and therefore does not appear in the "on the wire" instance.
[1..*] [M] pertinentInformation2 | This class links the CP-IS record access class to the pertinent CP-IS query.
[1..1] [M] typeCode (CS { CNE: ActRelationshipType } ) { Fixed="PERT" } | Model Attribute Description The HL7 attribute typeCode uses a code to describe this class as pertinent information. Implementation in XML Instance The XML attribute typeCode is fixed to "PERT". Schema Constraint The attribute typeCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.
[1..1] [M] pertinentCP-ISNHSQuery (CP-ISNHSQuery) | A link to the CP-IS query.
[1..1] [M] reference | This class links the CP-IS Record control act class to a reference for the local authority file reference number.
[1..1] [M] typeCode (CS { CNE: ActRelationshipType } ) { Fixed="REFR" } | Model Attribute Description The HL7 attribute typeCode uses a code to describe this class as reference. Implementation in XML Instance The XML attribute typeCode is fixed to "REFR". Schema Constraint The attribute typeCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.
[1..1] [M] referredToLAUploadFile (LAUploadFile) | A link to the local authority file.
LAUploadFile | This class represents the file that the child protection record information was carried in when uploaded on to CP-IS.
| Used by: CP-ISRecordAccess
[1..1] [M] classCode (CS { CNE: ActClass } ) { Fixed="OBS" } | Model Attribute Description The HL7 attribute classCode describes this class as observation. Implementation in XML Instance The XML attribute classCode is fixed to "OBS". Schema Constraint The attribute classCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.
[1..1] [M] moodCode (CS { CNE: ActMood } ) { Fixed="EVN" } | Model Attribute Description The HL7 attribute moodCode describes this class as an observation event. Implementation in XML Instance The XML attribute moodCode is fixed to "EVN". Schema Constraint The attribute moodCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.
[1..1] [M] code (CV { CNE:CP-ISObservationType } ) { Fixed="LAUFI" } | Model Attribute Description The HL7 attribute code uses a code from the CP-ISObservationType vocabulary to describe this as a local authority upload file identifier. Implementation in XML Instance The Coded Plain flavour of theCoded Value (CV) data type shall be used to carry this information in the XML element code as follows: The XML attribute code shall contain a fixed value of "LAUFI" The XML attribute codeSystem shall contain a fixed value of "2.16.840.1.113883.2.1.3.2.4.17.469" The XML attribute displayName shall contain a fixed value of "LA Upload File Id". Schema Constraint The attribute code is prohibited in the schema and therefore does not appear in the "on the wire" instance. The attribute codeSystem is prohibited in the schema and therefore does not appear in the "on the wire" instance. The attribute displayName is prohibited in the schema and therefore does not appear in the "on the wire" instance.
[1..1] [M] value (II) | Model Attribute Description The HL7 attribute value uses an identifying sequence number to identify the local authority upload file. Implementation in XML Instance The XML element value shall carry the sequence number as follows: The XML attribute root shall contain the OID "2.16.840.1.113883.2.1.3.2.4.18.46" The XML attribute extension shall contain the identifying sequence number.
CP-ISNHSQuery | This class is the control act for the original query payload.
| Used by: CP-ISRecordAccess
[1..1] [M] classCode (CS { CNE: ActClass } ) { Fixed="CACT" } | Model Attribute Description The HL7 attribute classCode describes this class as a control act. Implementation in XML Instance The XML attribute classCode is fixed to "CACT". Schema Constraint The attribute classCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.
[1..1] [M] moodCode (CS { CNE: ActMood } ) { Fixed="EVN" } | Model Attribute Description The HL7 attribute moodCode describes this class as a control act event. Implementation in XML Instance The XML attribute moodCode is fixed to "EVN". Schema Constraint The attribute moodCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.
[1..1] [M] code (CV { CNE:CP-ISMessageType } ) { Fixed="03" } | Model Attribute Description The HL7 attribute code uses a code from the CP-ISMessageType vocabulary to describe this control act as a CP-IS NHS Query message. Implementation in XML Instance The Coded Plain flavour of theCoded Value (CV) data type shall be used to carry this information in the XML element code as follows: The XML attribute code shall contain a fixed value of "03" The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.17.470" The XML attribute displayName shall contain a fixed value of "CP-IS NHS Query". Schema Constraint The attribute code is prohibited in the schema and therefore does not appear in the "on the wire" instance. The attribute codeSystem is prohibited in the schema and therefore does not appear in the "on the wire" instance. The attribute displayName is prohibited in the schema and therefore does not appear in the "on the wire" instance.
[1..1] [M] effectiveTime (TS) | Model Attribute Description The HL7 attribute effectiveTime is used to define the time the person made the CP-IS query. Implementation in XML Instance The XML attribute value of the XML element effectiveTime shall be populated with the time the query was made using a time stamp in the format yyyymmddhhmmss[+|-ZZzz] where: yyyy is the year mm is the month dd is the day hh is the hour mm is the minutes ss is the seconds [+|-ZZzz] is the time zone offset in hours and minutes
[1..1] [M] id (II) | Model Attribute Description The HL7 attribute id uses an identifier of the original CP-IS NHS query. Implementation in XML Instance The Identifier Global data type flavour is used to carry the identifier in the XML element id as follows: The XML attribute root shall contain the DCE UUID of the original query.
[1..1] [M] queryByParameter (QueryByParameter) | A link to the QueryByParameter class.
[1..1] [M] author | This participant class is the person who authored the query to the CP-IS system.
[1..1] [M] typeCode (CS { CNE: ParticipationType } ) { Fixed="AUT" } | Model Attribute Description The HL7 attribute typeCode describes this class as an author participation. Implementation in XML Instance The XML attribute typeCode is fixed to "AUT". Schema Constraint The attribute typeCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.
[1..1] [M] contentId (II) { "NPFIT-100037#Role" } | Model Attribute Description The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use. The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at runtime with a value from the allowed list contained in the model. Implementation in XML Instance The Identifier External data type flavour is used to carry this information in the XML element contentId as follows: The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.16" The XML attribute extension shall contain one of the allowed template artefact identifiers.
[1..1] [M] participant (AuthorChoice) | A link to the choice of author.
AuthorChoice | A choice of authors.
| Used by: CP-ISNHSQuery
[1..1] : Template2 |
QueryByParameter | This class is used to link all the parameters used in the query together.
| Used by: CP-ISNHSQuery
[1..1] [M] person.id (Person.id) | A link to the Person id class
Person.id | This class is used to hold a query parameter of the child's NHS Number. In this message it represents the NHS number of the child whose record access information is being returned to the local authority which uploaded the child protection information.
| Used by: QueryByParameter
[1..1] [M] semanticsText (ST) { Fixed="Person.id" } | Model Attribute Description The HL7 attribute semanticsText is used to hold a literal text string identifying the parameter item. Implementation in XML Instance The XML element semanticsText shall contain a fixed value of "Person.id". Schema Constraint The attribute semanticsText is prohibited in the schema and therefore does not appear in the "on the wire" instance.
[1..2] [M] value (SET<II>) | Model Attribute Description The HL7 attribute value is used to hold the NHS number of the patient that is a parameter in the query. This parameter is mandatory and the NHS number must be a valid verified nhs number. A local identifier may also be included. Implementation in XML Instance The XML element value should be populated as below: The XML attribute root shall contain the OID "2.16.840.1.113883.2.1.4.1" The XML attribute extension shall contain the 10 digit NHS number. Where the a local identifier is used then a second occurrence of the XML element value is populated as follows: The XML attribute root shall contain the OID "2.16.840.1.113883.2.1.3.2.4.18.24" The XML attribute extension shall contain the local patient identifier The XML attribute assigningAuthorityName shall contain the assigning organisation in the format of ODSCode:ODSName, for example: assigningAuthorityName="V145:LONDON BOROUGH OF ISLINGTON"