#### Child Protection
Domain Message Specification

### CP-ISInactiveNHSNumberNotification Tabular View

REPC_RM000005GB01 |
CP-ISInactiveNHSNumberNotification | This class represents the Child Protection Information Service's inactive NHS number notification.
| Used by:
[1..1] [M] classCode (CS { CNE: ActClass } ) { Fixed="INFRM" } | Model Attribute Description The HL7 attribute classCode describes this class as an inform act. 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 informing 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="06" } | 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 "06" 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 Inactive NHS Number 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 the notification message containing the inactive records was sent from the Child Protection Information Service to the Local Authority. 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 identify each unique instance of the notification (of inactive NHS Numbers for CP-IS). 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] primaryInformationRecipient | A class which is a participation of information recipient. This is the organisation which is being sent the inactive NHS number 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 an information recipient participation. Implementation in XML Instance The XML attribute typeCode 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.
[1..*] [M] subject | This participant class is the subject class for the PDS inactive patient which is the subject of the Child Protection Information Service inactive NHS number notification.
[1..1] [M] typeCode (CS { CNE: ParticipationType } ) { Fixed="SBJ" } | Model Attribute Description The HL7 attribute typeCode describes 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] pDSInactivePatient (PDSInactivePatient) | A link to the PDS inactive patient class.
PDSInactivePatient | The role of patient with a PDS inactive NHS number. This class will contain PDS inactive NHS number for the child whose NHS number has been stated to be inactive.
| Used by: CP-ISInactiveNHSNumberNotification
[1..1] [M] classCode (CS { CNE: RoleClass } ) { Fixed="PAT" } | Model Attribute Description The HL7 attribute classCode uses a code to describe this class as a role of patient. Implementation in XML Instance The XML attribute classCode is fixed to "PAT". Schema Constraint The attribute classCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.
[1..2] [M] id (SET<II>) | Model Attribute Description The HL7 attribute id contains the superseded inactive NHS number. This allows the Local Authority to identify the child's inactive NHS number. A local identifier may also be included. This is in addition to the NHS Number which will still remain the primary patient identifier. As a general rule, where a local identifier has been provided within the CP-IS Local Authority Upload message, then CP-IS will need to ensure that in any return messages to the Local Authority that the local identifier is also included. Implementation in XML Instance The inactive NHS number should be populated in the XML element id as follows: For a verified NHS Number: 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 the then a second occurrence of the XML element id 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"
[0..1] replacedBy | This class links the PDS inactive patient with the replacing new patient.
[1..1] [M] typeCode (CS { CNE: RoleLinkType } ) { Fixed="REPL" } | Model Attribute Description The HL7 attribute typeCode describes this class as a replacement role link. Where the source role replaces (or subsumes) the target Role. Implementation in XML Instance The XML attribute typeCode is fixed to "REPL". Schema Constraint The attribute typeCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.
[1..1] newVersion (NewNHSPatient) | A link to the new NHS patient.
[1..1] [M] subjectOf | This class links to the LA upload file which the PDS inactive patient was a subject of.
[1..1] [M] typeCode (CS { CNE: ParticipationType } ) { Fixed="SBJ" } | Model Attribute Description The HL7 attribute typeCode describes 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] lAUploadFile (LAUploadFile) | A link to the local authority upload file.
LAUploadFile | This class represents the file that the child protection record information was contained in when sent to be uploaded on to CP-IS.
| Used by: PDSInactivePatient
[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 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 "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. Schema Constraint The attribute root is prohibited in the schema and therefore does not appear in the "on the wire" instance.
NewNHSPatient | The role of patient who has a new NHS number. This class will contain the new NHS number for the child whose NHS number has been replaced.
| Used by: PDSInactivePatient
[1..1] [M] classCode (CS { CNE: RoleClass } ) { Fixed="PAT" } | Model Attribute Description The HL7 attribute classCode uses a code to describe this class as a role of patient. Implementation in XML Instance The XML attribute classCode is fixed to "PAT". Schema Constraint The attribute classCode 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 contains a new NHS Number. This allows the Local Authority to identify the child using the new available NHS number. Implementation in XML Instance The new NHS number should be populated in the XML element id as follows: For a verified NHS Number: 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.
RecipientChoice | A choice of recipient.
| Used by: CP-ISInactiveNHSNumberNotification
[1..1] : Template1 |