Change History
Version: 1.0; Status: RC5 Patch B
- TMS Implementation page
- An amendment to the description for QUQI_IN010000UK14 where the interaction description and hyperlink has changed from MCCI_MT010101UK12 to MCCI_MT020101UK12. Note, this amendment does not impact the message implementation, it simply corrects an error in the description.
Version: 1.0; Status: RC5 Patch A
- InfVocab.xsd
- The enumerated coded values of HL7StandardVersionCode have been amended in this schema.
- CP-IS Local Authority Acknowledgement Response example, REPC_EX000003GB01_01.xml
- The XPath for the AcknowledgementRecordDetail.Location has been corrected for an Invalid CP-IS record scenario.
Version: 1.0; Status: RC5
- CP-IS Upload Response File Error Reporting
- To support the mechansim for informing LA systems that their CP-IS client host is out of date and MUST be updated to latest version of client software, the CP-ISUploadFileResponse vocabulary has been extended. A new error "CPF06" code with a display name of "Spine ii rejected the request because this version of the CPIS Client is no longer supported." has been added to vocab. As a consequence the CP-ISUploadFileResponse vocabulary has been upversioned to 2.0.
- CPVocab Schema
- CPVocab schema upversioned to 2.0
- Configuration Profile
- All Configuration Profiles have been upversioned from 1.1 to 2.0. This reflects the upversioning of the CPVocab schema and the CP-ISUploadFileResponse vocabulary artefacts.
Version: 1.0; Status: RC4
- UnbornChildPlanInformationUpload (COCT_TP146102GB01) Template
- UCPDeleteDate (component2 actRelationship) cardinality changed to 0..1 optional.
- TMS Infrastructure Wrappers
- The TMS infrastructure wrappers specified in this release have been aligned with TMS infrastructure v5.7 (MIM 7.2.02).
- CP-IS NHS Query QUPC_IN000006GB01 Interaction Schema
- Subject XML element added to the the Control Act Wrapper. QUPC_IN000006GB01 interaction schema is now consistent with standard TMS Control Act Wrapper.
- Examples
- All examples have been updated to comply with the above changes.
- Datatypeflavours Schema
- Datatypeflavours schema upversioned to version 4.1
- Removed following flavors from this version of Data Types schema: II.NPfIT.patientId.withstatus, Cda.NPfIT.Url, Any.NPfIT.Url, Cda.NPfIT.ED, CD.NPfIT.CDA.Url, CE.NPfIT.CDA.Url and CV.NPfIT.CDA.Url - as they are not reference in any of the Child Protection schemas.
- ST.NHS.StringType5 flavor - attribute name="use" removed from complexType as illegal restriction
- Associated Specifications
- The Distribution Envelope Specification has been removed from this DMS. This is because the distribution envelope is used with ITK Correspondence content only.
- Child Protection Information Templates 'Timestamp' Implementation Guidence
- Tabular views guidance (1) on how the CP-IS system stores dates received from Local Authorities i.e. truncation of timestamp down to date e.g. "20140601" and (2) how the the CP-IS system then sends these dates within a CP-IS NHS Query Response to unscheduled care settings as a timestamp with the hours and minutes padded out with '0000' e.g. "201406010000".
Version: 1.0; Status: RC3
- Organisation Telecom
- The messages REPC_MT000003GB01 CP-IS Local Authority Acknowledgement Response and REPC_MT000007GB01 CP-IS NHS Query Response have the organisation telecom cardinality changed from 1..1 to 1..2 to align with the other CP-IS messages.
- Record Counts
- The message REPC_MT000003GB01 CP-IS Local Authority Acknowledgement Response tabular view has been changed to state in the case of invalid files, where the number of records sent for upload which are invalid and/or the total transmission quality cannot be determined CP-IS, the value -1 will be returned.
- Query Author
- The template COCT_TP145102GB01 CP-IS Author Person for CP-IS has been changed to use only people who are registered for a smart card. A new template COCT_TP145104GB01 CP-IS Author Device is used to record the system used for the query and details of the nominated person responsible.
- The vocabulary JobRoleName has been updated with CP-IS specific codes to describe the job role of the person who made / is making the query.
- CP-IS Upload Response Error Reporting
- The vocabulary CP-ISUploadRecordResponse has been updated with a new error code of "CPR07 Unsuccessful Upload" used with a qualifying code from a new vocabulary called CP-ISUploadRecordResponseDetail these codes are maintained in the Spine 2 EIS. The data type of the code attribute of the AcknowledgementRecordDetail class has been changed from CV to CE to allow this.
- The tabular view for CP-IS Upload Response has been updated to indicate that only 1 file level error is returned by CP-IS
- The tabular view for CP-IS Upload Response has been updated to indicate that when reporting file level errors and the identifier of the file cannot be determined CP-IS will return the value -1.
- Example Page and Examples
- The Example page description for query example has been changed to align with the new author query structure.
- All examples have been updated to comply with the changes listed above.
- Configuration Profile
- All Configuration Profiles have been upversioned to reflect the changes in the artefacts.
Version: 1.0; Status: RC2
- Rebranding
- This Domain Message Specification has been rebranded to HSCIC.
- Interaction Diagrams
- The TMS Implementation page includes interaction diagrams, these "swim lanes" support the Upload, Query and Notification interactions.
- Configuration Profiles
- Configuration profiles are included in this release.
- Trigger Events
- A new Trigger Event, Query Failed (QUQI_TE010000UK01), is included in this release.
- CP-IS Inactive NHS Number Notification Model
- The PDSInactivePatient.id cardinality has been changed to 1..2 to allow CP-IS to return any uploaded local patient identifier to identify the patient.
- CP-IS Access to Service Notification Model
- Within the Tabular View for the TotalRecordsReturned class, it previously stated for the number of queries that were made against “the NHS number...” , this has changed to "the total number of NHS numbers…”.
- A display issue with the model and tabular view for Person.id.value is corrected to show the data type SET (II).
- CP-IS Local Authority Upload Model
- The organisation's contact telephone number cardinality has been changed from 1..1 to 1..2. The XML attribute "use" carries the type of telephone number; this can be an emergency contact (mandatory) and/or work place contact (optional).
- CP-IS NHS Query Response Model
- An id attribute in the root class is included to identify each unique instance of the CP-IS NHS query response message to unscheduled care setting systems.
- CP-ISAuthorPerson template
- The AssignedAuthor id Tabular View description is updated to allow for non SDS (local) identifiers.
- Data Type Flavours
- The datatypeflavours.xsd schema has been amended to reflect that the TEL.NHS.value.mandatory data type flavour has changed to allow the use attribute.
- A new data type flavour II.NPfIT.oid.mandatoryAndEnumerated.assignedAuthority.optional is included in the datatypeflavours.xsd.
- Vocabularies
- The version 4.0 of the JobRoleName vocabulary replaces version 1.0 in the previous release.
- Examples
- XML Examples are changed to reflect modelling changes.
- Where effectiveTime has the time zone offset in hours and minutes (as described in the tabular view), this is reflected in the XML examples for CP-IS Access to Service Notification, CP-IS Inactive NHS Number Notification, CP-IS NHS Query and CP-IS NHS Query Response.
- A second example for CP-IS NHS Query is included to illustrate the author id field allowing for non SDS (local) identifiers.
- Associated Specifications
- The ITK Distribution Envelope Specification is added as an Associated Specification.
Version: 1.0; Status: RC1
- Schemas
- The messages in this DMS have schema generated by a new version of the schema generator. This results in fixed values being prohibited in the schema, which means that fixed values are not sent in the "on the wire" message (xml) instance. Message instances are therefore reduced in size and complexity. Where all attributes of an element are fixed and there are no child elements then that element is also removed to further reduce message size and complexity.
- Templating Mechanism
- All CP-IS messages have been re-modelled using the HSCIC templating mechanism. Using templates ensures greater extensibility, maintainability and consistency of messages.
- CP-IS Local Authority Upload Model
- CP-ISRecord child participation relationship classes replaced by constraint: NPFIT-100035#Role - CP-IS Record Subject with cardinality 1..2. Constraint contains (a) ChildSubject - COCT_TP145101GB01 (b) UnbornChildSubject - COCT_TP145100GB01 templates.
- CP-ISRecord careOrderType pertinent information relationship choice classes replaced by constraint: NPFIT-100017#Act - Child Protection Information templates. Cardinality 1..3 is maintained. Constraint contains: (a) ChildProtectionPlanInformationUpload COCT_TP146101GB01 (b) LookedAfterChildInformationUpload - COCT_TP146100GB01 (c) UnbornChildPlan InformationUpload - COCT_TP146102GB01 templates.
- CP-IS Local Authority Acknowledgment Response Model
- CP-ISRecord child participation relationship classes replaced by constraint: NPFIT-100035#Role - CP-IS Record Subject with cardinality 1..2. Constraint contains (a) ChildSubject - COCT_TP145101GB01 (b) UnbornChildSubject - COCT_TP145100GB01 templates.
- CP-ISRecord careOrderType pertinent information relationship choice classes replaced by constraint: NPFIT-100017#Act - Child Protection Information templates. Cardinality 1..3 is maintained. Constraint contains: (a) ChildProtectionPlanInformationUpload COCT_TP146101GB01 (b) LookedAfterChildInformationUpload - COCT_TP146100GB01 (c) UnbornChildPlan InformationUpload - COCT_TP146102GB01 templates.
- AcknowledgementFile (Acknowledgement) class cardinality is now 1..1 mandatory.
- SuccessfulCP-ISRecords and FailedReturnedCP-ISRecords (AttentionLine) class cardinality are now 1..1 mandatory.
- CP-IS NHS Query Model
- CP-ISNHSQuery author participation relationship classes replaced by constraint: NPFIT-100037#Role - CP-IS Query Author. Cardinality 1..1 is maintained. Constraint contains the CP-ISAuthorPerson - COCT_TP145102GB01 template.
- CP-IS NHS Query Response Model
- CP-ISNHSQuery author participation relationship classes replaced by constraint: NPFIT-100037#Role - CP-IS Query author. Cardinality 1..1 is maintained. Constraint contains the CP-ISAuthorPerson - COCT_TP145102GB01 template.
- CP-ISRecord child participation relationship classes replaced by constraint: NPFIT-100035#Role - CP-IS Record Subject with cardinality 1..2. Constraint contains (a) ChildSubject - COCT_TP145101GB01 (b) UnbornChildSubject - COCT_TP145100GB01 templates.
- CP-ISRecord careOrderType pertinent information relationship choice classes replaced by constraint: NPFIT-100018#Act - Child Protection Information templates. Cardinality 1..3 is maintained. Constraint contains: (a) ChildProtectionPlanInformation - COCT_TP146105GB01 (b) LookedAfterChildInformation - COCT_TP146103GB01 (c) UnbornChildPlanInformation - COCT_TP146104GB01 templates.
- CP-IS Access To Service Notification Model
- CP-ISAccessToServiceNotification primary Information Recipient participation relationship classes replaced by constraint: NPFIT-100036#Role - CP-IS Notification Recipient Templates. Cardinality 1..1 is maintained. Constraint contains the CP-ISRecipient Organization - COCT_TP145103GB01 template.
- CP-ISNHSQuery author participation relationship classes replaced by constraint: NPFIT-100037#Role - CP-IS Query author. Cardinality 1..1 is maintained. Constraint contains the CP-ISAuthorPerson - COCT_TP145102GB01 template.
- CP-IS Inactive NHS Number Notification Model
- CP-ISInactiveNHSNumberNotification primary Information Recipient participation relationship classes replaced by constraint: NPFIT-100036#Role - CP-IS Notification Recipient Templates. Cardinality 1..1 is maintained. Constraint contains the CP-ISRecipient Organization - COCT_TP145103GB01 template.
- NewNHSNumber role class renamed to NewPatient.
- PDSInactiveNHSNumber role class renamed to PDSInactivePatient.
- Child Protection Information Templates
- CP-IS Local Authority Upload and CP-IS Local Authority Acknowledgment Response models contain the following new Child Protection Information templates: ChildProtectionPlanInformationUpload, LookedAfterChildInformationUpload, UnbornChildPlanInformationUpload.
- CP-IS NHS Query Response model contains the following new Child Protection Information templates: ChildProtectionPlanInformation, LookedAfterChildInformation, UnbornChildPlanInformation.
- Vocab Change
- CP-ISObservationType - new code values added to support the new Child Protection Information templates.
- CP-ISUploadRecordResponse vocab replaces CP-ISRecordValidationType vocab - code values and descriptions refined.
- CP-ISUploadFileResponse vocab replaces CP-ISFileValidationType vocab - code values and descriptions refined.
- Datatype Flavors
- New flavours added to datatypeflavours.xsd: PN.NHS.Internal, PN.NHS.PersonNameType6, ON.NHS.OrganizationNameType1, TS.NHS.DateType1, TEL.NHS.value.mandatory, ST.NHS.StringType5, II.NHS.extension.mandatory.
Version: 1.0; Status: Draft B
- CP-IS Local Authority Upload model, CP-IS Local Authority Acknowledgment Response Model
- Organisation entity class simplified to include id and telecom attributes.
- Child address attribute removed from model.
- Additional supporting information (scoped father/ mother/ carer/ sibling role classes) removed from model.
- CP-IS NHS Query Model
- Date of birth, given name and family name query parameters removed from model.
- CP-IS NHS Query Response Model
- Organisation entity class simplified to include id and telecom attributes.
- Child address attribute removed from model.
- Additional supporting information (scoped father/ mother/ carer/ sibling role classes) removed from model.
- LAUploadfFile class removed from model.
- CPPDeleteDate, LookedAfterChildDeleteDate and UnbornChildCPPDeleteDate classes removed from model.
- CP-IS Access to Service Notification Model
- SourceOrganisation entity class simplified to include id attribute.
- Person.NHSnumber ParameterItem class and semanticsText attribute renamed to Person.id.
- CP-IS Inactive NHS Number Notification Model
- Cardinality on new NHS number changed to 0..1.
- Data types and vocab cross references
- Added to this release.
Version: 1.0; Status: Draft A
- Specification
- First draft version (Version 1.0 Draft A) created.