#### Child Protection
Domain Message Specification

### CP-ISNHSQueryResponse Tabular View

REPC_RM000007GB01 |
CP-ISNHSQueryResponse | This class represents the query response. The query response returns all child protection records held on CP-IS and all information on previous queries made for the stated NHS number, including the concurrent query author details. The query response will always include details of the query author who made the request, so there will always be at least one query author listed in a query response. If the same author has previously viewed the same CP-IS record within a 24 hour period then only details of the first query will be included in the response.
| Used by:
[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="04" } | 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 Response message. Implementation in XML Instance The Coded Plain flavour of the Coded 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 "04" The XML attribute codeSystem shall contain a fixed value of "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 Response". 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 of the CP-IS query response. Implementation in XML Instance The XML attribute value of the XML element effectiveTime shall be populated with the time the query response 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 to identify each unique instance of the CP-IS NHS query response message to unscheduled care setting systems. Implementation in XML 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] pertinentInformation11 | This class links the CP-IS Query response class to the pertinent total returned access records. This refers is to the total number of access records which equates to the number of successful queries made against this NHS number.
[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] pertinentTotalReturnedAccessRecords (TotalReturnedAccessRecords) | A link to the total returned access records.
[1..1] [M] pertinentInformation12 | This class links the CP-IS Query response class to the pertinent total number of child records returned.
[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] pertinentTotalReturnedChildRecords (TotalReturnedChildRecords) | A link to the total returned child records.
[0..*] pertinentInformation13 | This class links the CP-IS Query response class to the pertinent CP-IS queries. These queries are returned in the response to indicate an audit of who has queried CP-IS using this NHS number.
[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] pertinentCP-ISNHSQuery (CP-ISNHSQuery) | A link to the CP-IS NHS Query.
[1..*] [M] pertinentInformation14 | This class links the CP-ISQuery response class to the pertinent CP-IS record control act. Child protection records are returned in a query response. Indicates the number of records held on CP-IS for this NHS number.
[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-ISRecordControlAct (CP-ISRecordControlAct) | A link to the CP-IS record control act.
CP-ISNHSQuery | This class is the control act for each successful query against this NHS number.
| Used by: CP-ISNHSQueryResponse
[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 message. Implementation in XML Instance The Coded Plain flavour of the Coded 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 to reference the original CP-IS 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 (queried) 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] : Template1 |
QueryByParameter | This class is used to link all the parameters used in the query together.
| Used by: CP-ISNHSQuery
[1..1] [M] person.NHSnumber (Person.NHSnumber) | A link to the Person.NHSnumber parameter item.
Person.NHSnumber | This class is used to hold a query parameter of the NHS number.
| Used by: QueryByParameter
[1..1] [M] semanticsText (ST) { Fixed="Person.NHSnumber" } | 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.NHSnumber". Schema Constraint The attribute semanticsText 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 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. 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. Schema Constraint The attribute root is prohibited in the schema and therefore does not appear in the "on the wire" instance.
TotalReturnedChildRecords | This class contains the number of records held on CP-IS for this NHS number which matched. These records will be returned in the CP-IS record structure of the message.
| Used by: CP-ISNHSQueryResponse
[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="TRCR" } | Model Attribute Description The HL7 attribute code uses a code from the CP-ISObservationType vocabulary to describe this class the total of returned records. Implementation in XML Instance The Coded Plain flavour of the Coded 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 "TRCR" 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 Child 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 returned child protection records for the queried NHS number. Implementation in XML Instance The XML element value should be populated as follows: The XML attribute value shall contain the total number of records.
TotalReturnedAccessRecords | This class contains the total of returned access records. This is the total number of queries made on CP-IS for this NHS number which matched. i.e. there was child protection record found. The details of the queries are returned in the query structure within this message.
| Used by: CP-ISNHSQueryResponse
[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="TRAR" } | Model Attribute Description The HL7 attribute code uses a code from the CP-ISObservationType vocabulary to describe this class as a total number of returned access records. Implementation in XML Instance The Coded Plain flavour of the Coded 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 "TRAR" 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 Access 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 returned access records for the stated NHS number. 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-ISRecordControlAct | This class represents the child protection record information which is available on CP-IS.
| Used by: CP-ISNHSQueryResponse
[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..*] [M] record (Record) | A link to the record class.
Record | The Record class is a dummy class used to connect the file class to the record.
| Used by: CP-ISRecordControlAct
[1..1] [M] communicationFunctionSnd (CommunicationFunctionSnd) | A link to the communication function send class.
[1..1] [M] CP-ISRecord | This class represents the child protection record information which was present on CP-IS.
[1..1] [M] classCode (CS { CNE: ActClass } ) { Fixed="ACTN" } | Model Attribute Description The HL7 attribute classCode describes this class as an action. Implementation in XML Instance The XML attribute classCode is fixed to "ACTN". 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="RQO" } | Model Attribute Description The HL7 attribute moodCode describes this class as an action request. Implementation in XML Instance The XML attribute moodCode is fixed to "RQO". 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="01" } | Model Attribute Description The HL7 attribute code uses a code from the CP-ISMessageType vocabulary to describe this control act as a CP-IS message. Implementation in XML Instance The Coded Plain flavour of the Coded 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 "01" The XML attribute codeSystem shall contain a fixed value of "2.16.840.1.113883.2.1.3.2.4.17.470" The XML attribute displayName shall contain a fixed value of "CP-IS Local Authority Upload". 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..2] [M] subject (Subject) |
CommunicationFunctionSnd | This class is the send function class used to link the sender's details to the record.
| Used by: Record
[1..1] [M] typeCode (CS { CNE: CommunicationFunctionType } ) { Fixed="SND" } | Model Attribute Description The HL7 attribute typeCode uses a code from the communicationFunctionType vocabulary to describe this class as a send function. Implementation in XML Instance The XML attribute typeCode is fixed to "SND". Schema Constraint The attribute typeCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.
[1..1] [M] organisation (Organisation) | A link to the sending organisation.
Organisation | This class details the organisation which sent the CP-IS upload.
| Used by:
[1..1] [M] classCode (CS { CNE: EntityClass } ) { Fixed="ORG" } | Model Attribute Description The HL7 attribute classCode describes this class as an organisation. Implementation in XML Instance The XML attribute classCode is fixed to "ORG". Schema Constraint The attribute classCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.
[1..1] [M] determinerCode (CS { CNE: EntityDeterminer } ) { Fixed="INSTANCE" } | Model Attribute Description The HL7 attribute determinerCode describes this class as an instance of an organisation. Implementation in XML Instance The XML attribute determinerCode is fixed to "INSTANCE". Schema Constraint The attribute determinerCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.
[1..1] [M] id (II) | Model Attribute Description The HL7 attribute id uses an ODS code as an identifier that uniquely identifies the sending organisation. The ODS code should identify the organisation at either the site level or organisation level. Where possible the organisation should be identified at the site level. ODS codes were formerly known as NACS codes. Implementation in XML Instance When ODS site code is used then the XML element id is populated in the following way: The XML attribute root shall contain an OID with the value "2.16.840.1.113883.2.1.3.2.4.19.2" The XML attribute extension shall contain the ODS site code. When ODS organisation code is used then the XML element id is populated in the following way: The XML attribute root shall contain an OID with the value "2.16.840.1.113883.2.1.3.2.4.19.1" The XML attribute extension shall contain the ODS organisation code.
[1..1] [M] name (ON) | Model Attribute Description The HL7 attribute name uses the description of the organisation associated with the ODS code. Implementation in XML Instance The XML element name will carry the description associated with the ODS code carried in the XML attribute extension of the XML element id.
[1..2] [M] telecom (SET<TEL>) | Model Attribute Description The HL7 attribute telecom provides a contact telephone number for the organisation. Implementation in XML Instance This XML element telecom should be populated as below: The XML attribute value of the XML element telecom should contain the telephone number. For a telephone number the actual telephone number would be prefixed with tel: The XML attribute use of the XML element telecom must be used to give further information about the type of contact details contained in the XML attribute value. Only the use values listed below are recommended for the contact details:
Code | Definition
--- | ---
EC | Emergency Contact - A contact used by clinicians in Out of Office hours (this is mandatory).
WP | Work place - A contact during business hours (this is optional, but if it is available it should be included).
CP-ISRecord | This class represents the child protection record information which was present on CP-IS.
| Used by:
[1..1] [M] classCode (CS { CNE: ActClass } ) { Fixed="ACTN" } | Model Attribute Description The HL7 attribute classCode describes this class as an action. Implementation in XML Instance The XML attribute classCode is fixed to "ACTN". 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="RQO" } | Model Attribute Description The HL7 attribute moodCode describes this class as an action request. Implementation in XML Instance The XML attribute moodCode is fixed to "RQO". 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="01" } | Model Attribute Description The HL7 attribute code uses a code from the CP-ISMessageType vocabulary to describe this control act as a CP-IS message. Implementation in XML Instance The Coded Plain flavour of the Coded 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 "01" The XML attribute codeSystem shall contain a fixed value of "2.16.840.1.113883.2.1.3.2.4.17.470" The XML attribute displayName shall contain a fixed value of "CP-IS Local Authority Upload". 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..3] [M] pertinentInformation15 | This class links the CP-ISRecord class to the pertinent child protection 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] [M] contentId (II) { "NPFIT-100018#Act" } | 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] pertinentChildProtectionInformationChoice (ChildProtectionInformationChoice) | A link to the choice of child protection information.
[1..2] [M] subject | A class which is a participation of subject. The child who is the subject of the CP-IS record.
[1..1] [M] typeCode (CS { CNE: ParticipationType } ) { Fixed="SBJ" } | Model Attribute Description The HL7 attribute typeCode uses a code to describe this class as a subject participation. Implementation in XML Instance The XML attribute typeCode is fixed to "SBJ". 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-100035#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 (SubjectChoice) | A link to the choice of subjects.
SubjectChoice | A choice of subjects.
| Used by: CP-ISRecord
[1..1] : Template2 |
ChildProtectionInformationChoice | A choice of child protection information.
| Used by: CP-ISRecord
[1..1] : Template3 |