Guidance for Creation of an NHS 111 Repeat Caller Query

Transcription

1 Document filename: Document1 Directorate / Programme NHS111 Project NHS111 Document Reference Project Manager Tony Yates Status Final Owner Tony Yates Version 1.0 Author David Barnet Version issue date 04/10/2013 Guidance for Creation of an NHS 111 Repeat Caller Query

2 Document Management Revision History Version Date Summary of Changes /01/2012 First Version for comment /10/2013 Rebranded HSCIC & made Final Reviewers This document must be reviewed by the following people: author to indicate reviewers Reviewer name Title / Responsibility Date Version Kevin Sprague Interoperability Team Lead 11/08/ Kevin Sprague Interoperability Team Lead 04/10/ Approved by This document must be approved by the following people: author to indicate approvers Name Signature Title Date Version Richard Kavanagh Interoperability Development Manager 11/08/ Glossary of Terms Term / Abbreviation CDA Participation Role DCE UUID XML DMS PDS What it stands for Clinical Document Architecture (a HL7 standard for Clinical Documents) involvement of a role in an act A responsibility or part played by an entity Distributed Computing Environment Universally Unique Identifier - is an identifier standard used in software construction Extensible Markup Language - is a general-purpose specification for creating custom markup languages Domain Message Specification (sometimes called a pack) is the message specification(s) offered by Connecting for Health for a domain (such as NHS 111) Patient Demographic Service the NHS patient database Document Control: Page 2 of 11

3 controlled copy of this document is maintained in the HSCIC corporate network. Any copies of this document held outside of that area, in whatever format (e.g. paper, attachment), are considered to have passed out of control and should be checked for currency and validity. Page 3 of 11

4 Contents 1 Introduction Purpose of Document 5 2 Guidance for creating an NHS 111 Repeat Caller Query HL7 V3 Reminder Populating the Repeat Caller Query Message 5 Page 4 of 11

5 1 Introduction 1.1 Purpose of Document This document provides guidance for creating an NHS 111 Repeat Caller Query message. document includes the information that an NHS 111 system needs to supply to create the query. 2 Guidance for creating an NHS 111 Repeat Caller Query 2.1 HL7 V3 Reminder A note to remind developers that the NHS 111 Repeat Caller Query is NOT a CDA document. refore, there is no concept of on-the-wire and conformance schemas. schema provided for the NHS 111 Repeat Caller Query is BOTH the conformance and onthe-wire schema. 2.2 Populating the Repeat Caller Query Message This section documents the various NHS111 Repeat Caller Query classes and concepts, and what data is required to populate the message. For the optionality of each data item, consult the NHS 111 Repeat Caller Query model. Further guidance on data s is given on the associated model tabular view. Page 5 of 11

6 Class: RepeatCallerQuery Data Item classcode moodcode Business relevance None, a None, a A unique identifier for the query. Must be a DCE UUID None, a Acts as a header for the Repeat Caller Query Value Guidance Xpath Example Always FIXED to CACT /RepeatCallerQuery/@classCode < RepeatCallerQuery classcode="cact " moodcode="evn"> Always FIXED to EVN /RepeatCallerQuery/@moodCode < RepeatCallerQuery classcode="pcpr " moodcode="rqo"> A generated DCE UUID /RepeatCallerQuery /id/@root <id root="b709a442-3cf4-476e e829c9"/> Always FIXED Code 01 CodeSystem /RepeatCallerQuery //@ /RepeatCallerQuery //@System < ="01" System=" "/> effectivetime/@ date and time the query was produced system date/time when the query was made. This can be to any precision, but to the second is recommended /RepeatCallerQuery /effectivetime/@ <effectivetime =" "/> Concept: author Data Item author/typecode Business relevanc e Contains the document author details. NOTE it is expected that author details will conform to the AuthorPersonUniversal conformance profile only. Includes classes Author; assignedauthor; representedorganization; assignedperson Value Guidance Xpath Example Always FIXED to AUT /RepeatCallerQuery/author/@typeCode <author typecode="aut" contextcontrolcode="op"> Page 6 of 11

7 author/contextcontrolcode Always FIXED to OP <author typecode="aut" contextcontrolcode="op"> Varies according to the type of author. Assuming person Universal author only Assuming Author Person Universal template only Always FIXED Root " Extension "COCD_TP145200GB01#A ssignedauthor <npfitlc:contentid 18.16" extension="cocd_tp145200gb01 #AssignedAuthor"/> hor/classcode Always FIXED to <COCD_TP145200GB01.Assigned Author classcode="assigned"> Identifiers to indicate the author this might be an SDS identifier (by preferenc e), or a local one (or both) A system identifier such as for an SDS identifier, or for a local identifier, and the identifying i d/@root i d/@extension <id 18.24" extension="100"/> hor//@ hor//@system hor//@displayname A that describes the author s job role this might be from A system identifier such as for an SDS Job Role, or a local system and a from that system /@ /@System /@displayname < ="OOH02" System=" " displayname="nurse Practitioner"/> Page 7 of 11

8 SDS (by preferenc e), or a local hor/addr/@use hor/addr/streetaddressline[1.. 5] hor/addr/postalcode address of the author An address for the author maybe from SDS. Use attribute will be to WP (work place). For consistency, only have street addressline and post as well as the use attribute addr/@use addr/streetaddressline addr/postalcode <addr use=" WP"> <streetaddressline> Hospital</streetAddressLine> <streetaddressline>hospital Road</streetAddressLine> <postalcode>cb1 1AA</postalCode> </addr> hor/telecom/@ Phone or details of the author maybe from SDS Author s telecom details. Can be a telephone number, address etc. Fix the use attribute to EC (emergency contact) t elecom/@ <telecom =tel: use= EC /> hor/templateid/@root hor/templateid/@extension Always FIXED to Root " " Extension "COCD_TP145200GB01#A ssignedauthor" t emplateid/@root t emplateid/@extension <templateid 18.2" extension="cocd_tp145200gb01 #AssignedAuthor"/> assignedperson/@classcode Always FIXED to PSN assignedperson/@classcode <assignedperson classcode="psn" determinercode="instance"> assignedperson/determinerco de Always FIXED to INSTANCE assignedperson/@determinercode <assignedperson classcode="psn" determinercode="instance"> assignedperson/name/prefix name of the name of the author maybe from SDS. In structured format of prefix, assignedperson/name/prefix <name> Page 8 of 11

9 assignedperson/name/given assignedperson/name/surnam e author given name and family name assignedperson/name/given assignedperson/name/family <prefix>ms</prefix> <given>mary</given> <family>jones</family> </name> assignedperson/templateid/@ root assignedperson/templateid/@ extension Always FIXED to Root " " Extension assignedperson/templateid/@root assignedperson/templateid/@extension <templateid 18.2" extension="cocd_tp145200gb01 #assignedperson"/> "COCD_TP145200GB01#a ssignedperson" representedorganization/class Code representedorganization/deter minercode representedorganization/id/@ root representedorganization/id/@ extension representedorganization/nam e Either the organisati on site (preferred ), or the organisati on of the author organisati on name associate d with the Always FIXED to ORG Always FIXED to INSTANCE If a site, root FIXED to If an org, root FIXED to Plus the actual Name associated with the in the id attribute r epresentedorganization/@classcode r epresentedorganization/@determinercode r epresentedorganization/id/@root r epresentedorganization/id/@extension r epresentedorganization/name representedorganization/temp Always FIXED to r <templateid <representedorganization classcode="org" determinercode="instance"> <representedorganization classcode="org" determinercode="instance"> <id 19.2" extension="5l399"/> <name>chelmsford Trust NHS 111 site</name> Page 9 of 11

10 lateid Root " " Extension r 18.2" extension="cocd_tp145200gb01 #representedorganization"/> "COCD_TP145200GB01#r epresentedorganization" Concept: Query and query parameters Details of the query parameters Data Item person.birthtime/semanticste xt e person.familyname/semantics Text person.familyname/ person.givenname/semantics Text person.givenname/ Business relevanc e date of birth family name given Value Guidance Xpath Example Always to Person.birthTime /RepeatCallerQuery/query/person.birthTime/semanticsText <semanticstext>person.birthtime< /semanticstext> date of birth /RepeatCallerQuery/query/person.birthTime//@ < =" "/> Always to Person.familyName /RepeatCallerQuery/query/person.familyName/semanticsText <semanticstext>person.familynam e</semanticstext> family name /RepeatCallerQuery/query/person.familyName/ <>Johnson</> Always to Person.givenName /RepeatCallerQuery/query/person.givenName/semanticsText <semanticstext>person.givennam e</semanticstext> given name /RepeatCallerQuery/query/person.givenName/ <>Jason</> Page 10 of 11

11 name person.id/semanticstext person.postalcode/semantics Text person.postalcode/ person.streetaddressline1/ semanticstext person.streetaddressline1/val ue NHS Number post street address line 1 Always to Person.id /RepeatCallerQuery/query/person.id/semanticsText <semanticstext>person.id</seman ticstext> Root is always to Extension is the NHS Number Always to Person.postalCode /RepeatCallerQuery/query/person.id//@root /RepeatCallerQuery/query/person.id//@extension /RepeatCallerQuery/query/person.postalCode/semanticsText < root=" " extension=" "/> <semanticstext>person.postalcod e</semanticstext> post /RepeatCallerQuery/query/person.postalCode/ <>B8 7GF</> Always to Person.streetAddressLine 1 street address line 1 /RepeatCallerQuery/query/person.streetAddressLine1/semanticsText /RepeatCallerQuery/query/person.streetAddressLine1/ <semanticstext>person.streetaddr essline1</semanticstext> <>65 Fir Tree Avenue</> Page 11 of 11