EDIFACT MESSAGE IMPLEMENTATION GUIDELINES RECEP:0:2:FH:

Transcription

1 EDIFACT MESSAGE IMPLEMENTATION GUIDELINES RECEP:0:2:FH: Version Number: 1.5 Issue Date: 3 rd April 2000 Message Type : RECEP Version : 0 Release : 2 Controlling Agency : FH Assoc Assigned Code : Crown Copyright 2000 NHS Information Authority Telephone: (01392) Hexagon House Fax (01392) P.O. Box 78 Pynes Hill Rydon Lane Exeter EX2 5SE

2 DOCUMENT CONTROL This document is controlled by the Networks Section, NHS Information Authority. Owner: MediFACT Product Manager AMENDMENT HISTORY Date Oct 97 Change National Data Standards Project - Party ID changed to free text 25/01/00 Amended to reflect change of names from FHSA to HA and from FHSCU to NHSIA 03/04/00 Clarification of data element 3055 in NHS segment. Version: 1.5 Date: 03/04/00 Page: 2 of 26

3 CONTENTS 1 Introduction 2 Scope 2.1 Functional definition 2.2 Field of application 2.3 Principles 3 References 4 Terms and definitions 5 Message definition 5.1 Data segment clarification 5.2 Branching diagram 5.3 Segment table 6 Directories 6.1 Data segment index 6.2 Segment implementation guidelines 7 EDIFACT Reference Directory 7.1 Formal definition of composites 7.2 Formal definition of data elements 7.3 Data element code values 8 Examples of Receipt Reports Version: 1.5 Date: 03/04/00 Page: 3 of 26

4 1. Introduction This specification provides the definition of the Receipt Report Message (RECEP) to be used in Electronic Data Interchange (EDI) between partners involved in the area of patient healthcare. 2 Scope 2.1 Functional definition A receipt report message is sent between a Health Authority (HA) and another Health Service body in order to acknowledge receipt of an EDIFACT message. 2.2 Field of application This message may be applied nationally for all HAs and for any body which has capability for using EDIFACT. 2.3 Principles The overall structure of the message is one message for one received EDIFACT interchange. A report will automatically be produced for each interchange received indicating the success or failure of receipt of that interchange. 3. References The receipt report message conforms to the following standards (please refer to these standards) : Syntax ISO 9735 Electronic Data Interchange for Administration, Commerce and Transport (EDIFACT) Application Level Syntax Rules. Data Elements ISO 7232 UN Trade Data Elements (UNTDED) Version: 1.5 Date: 03/04/00 Page: 4 of 26

5 The UN/ECE have combined the required data elements from ISO 7232 with the associated segments, composite data elements and codes into a set of directories called the UNTDID. This directory is now revised each year and the 90.2 version has been used in this message definition. Segments EDSD UN/EDIFACT Data Segments Directory. Composite Elements Data EDCD UN/EDIFACT Composite Data Elements Directory. Data Elements EDED UN/EDIFACT Data Elements Directory. Code Lists EDCL UN/EDIFACT Code Lists. These directories are taken from release Terms and definitions See UNTDID, Part 4, Section 2.5, UN/ECE UNSM General introduction, Section 1 or the SITPRO EDIFACT service, volume 3, data definitions. Version: 1.5 Date: 03/04/00 Page: 5 of 26

6 5. Message definition 5.1 Data segment clarification This section should be read in conjunction with the Branching diagram and the Segment table which indicate mandatory, conditional and repeating requirements. Segments additional to the 90.2 directory are marked with "+". Segments modified from the 90.2 directory are marked with "*". Heading section Information to be provided in the Heading section: UNH, Message header A service segment starting and uniquely identifying a message. The message type code for the receipt report message is RECEP. BGM, Beginning of message A segment to indicate the beginning of a message and to transmit the job type and transmission date and time. +NHS, National Health Body A segment referencing Health organisations. DTM, Date/Time/Period Contains the date and time an interchange is received. Detail section Information to be provided in the Detail section: RFF, Reference A segment referencing the sequence number and status of a received interchange. Will also contain the sequence number and status for each received message. Version: 1.5 Date: 03/04/00 Page: 6 of 26

7 Summary section Information to be provided in the summary section UNT, Message trailer A service segment ending in a message, giving the total number of segments in the message and the message sequence number. Version: 1.5 Date: 03/04/00 Page: 7 of 26

8 5.2 Branching Diagram Level 0 UNH BGM NHS DTM UNT M 1 M 1 M 1 M 1 M 1 1 RFF M Version: 1.5 Date: 03/04/00 Page: 8 of 26

9 5.3 Segment table UNH Message Header M 1 BGM Beginning of Message M 1 +NHS Health Body M 1 DTM Date/Time/Period M 1 RFF Reference M UNT Message Trailer M 1 Version: 1.5 Date: 03/04/00 Page: 9 of 26

10 6. Directories 6.1 Data segment index (Alphabetic sequence) The following list of segments without any prefixed sign are included in the 90.2 TRIAL directory. Segments additional to the 90.2 directory are marked with "+". BGM DTM +NHS RFF UNH UNT BEGINNING OF MESSAGE DATE/TIME/PERIOD HEALTH BODY REFERENCES MESSAGE HEADER MESSAGE TRAILER 6.2 Segment implementation guidelines The full definitions of the segments are to be found in UNTDID part 5, chapter 3, UN/EDIFACT Data Segment Directory (EDSD). NB: For elements defined as being at conditional status, the following additional codes are used to clarify the requirement for this implementation: R = Required (ie mandatory) for this implementation N = Not used by this implementation NB: The change in name from FHSA to HA has been reflected where possible. Where a qualifier or code value was originally defined containing FHSA, the change shows the new name of HA but retains the previous name in parentheses. eg. HA(FHSA) Version: 1.5 Date: 03/04/00 Page: 10 of 26

11 BGM BEGINNING OF MESSAGE To indicate the beginning of a message and to transmit message type, job code, and transaction date and time. No Data Element and value/description Usage Format C002 DOCUMENT/MESSAGE NAME N 1001 Document/message name, coded C an Code list qualifier C an Code list responsible agency, C an..3 coded 4774 Textual equivalent of the C an..35 associated coded representation 1004 DOCUMENT/MESSAGE NUMBER R an Job code = 600 C507 DATE/TIME/PERIOD R 2005 Date/Time/Period qualifier M an = Transmission of document date 2782 Date/Time/Period M an Relevant date 2781 Date/Time/Period format qualifier M an = CCYYMMDDHHMM CC = Century, YY = Year, MM = Month, DD = Day HH = Hour, MM = Minute 1225 MESSAGE FUNCTION, CODED R an = Message receipt report C506 REFERENCE N 1153 Reference qualifier M an Reference number C an Line number C an..6 C507 DATE/TIME/PERIOD N 2005 Date/Time/Period qualifier M an Date/Time/Period M an Date/Time/Period format qualifier M an RESPONSE TYPE, CODED N an..3 Version: 1.5 Date: 03/04/00 Page: 11 of 26

12 DTM DATE/TIME/PERIOD To specify a date, time, period. To transmit the receipt date and time. No Data Element and value/description Usage Format C507 DATE/TIME/PERIOD M 2005 Date/time/period qualifier M an = receive date of interchange 2782 Date/time/period M an Relevant date 2781 Date/time/period format qualifier 306 = CCYYMMDDHHMM CC = Century, YY = Year, MM = Month, DD = Day HH = Hour, MM = Minute M an..3 Version: 1.5 Date: 03/04/00 Page: 12 of 26

13 +NHS HEALTH BODY To identify health bodies. Notes: No Data Element and value/description Usage Format C082 PARTY IDENTIFICATION DETAILS R 3039 Party Id identification M an HA(FHSA) cipher 1131 Code list qualifier R an = HA(FHSA) (2, 3 char) code 3055 Code list responsible agency, coded C an = NHS Information Authority or GB2 = NHS Information Authority 4774 Textual equivalent of the associated coded N an..35 representation C082 PARTY IDENTIFICATION DETAILS R 3039 Party Id identification M an HA(FHSA) cipher - GP code allocated by HA(FHSA) [now interpreted as free text] - Screening Office code - Cytology Lab code - Child Health Unit code 1131 Code list qualifier R an = HA(FHSA) code = GP local code = Screening Office code defined by the HA(FHSA) = Cytology lab code = Child Health Unit code 3055 Code list responsible agency, coded C an = NHS Information Authority or GB2 = NHS Information Authority = Local HA(FHSA) 4774 Textual equivalent of the associated coded representation N an..35 Party Id details occurrence 2 As from Oct 97 the second occurrence of Party Id details will be free text for all interchanges between an HA and a GP (for all HA/GP Links Message Types) - previously this contained the organisation code eg. GP code - this can still be the case. If the message is transferred between two HAs the first occurrence of Party Identification Details will hold the sending HA and the second occurrence can hold the receiving HA. Version: 1.5 Date: 03/04/00 Page: 13 of 26

14 If the message is transferred between an HA and another health body (in either direction) the first occurrence of Party Identification Details will hold the HA and the second occurrence can hold the other health body. Code list responsible agency This data element is optional. If you choose to use it, it should be set as follows: To specify a code list responsible agency of the NHS Information Authority (previously FHSCU), enter 201 or GB2. Both these codes are valid. To specify a code list responsible agency of the Local Health Authority, enter 202. Version: 1.5 Date: 03/04/00 Page: 14 of 26

15 RFF REFERENCE To specify the identifying number associated with a transaction. To reference the sequence number and status for received interchange and message(s). No Data Element and value/description Usage Format C506 REFERENCE M 1153 Reference qualifier M an..3 MIS = received message sequence and status RIS = received interchange sequence and status 1154 Reference number R an message sequence number and status - interchange sequence number and status 1156 Line number R an..6 - number of messages received C507 DATE/TIME/PERIOD N 2005 Date/time/period qualifier M an Date/time/period M an Date/time/period format qualifier M an..3 Note: Details for messages received will be sent in one repetition of the segment for each message, with qualifier MIS. Information on the interchange will be included once using qualifier RIS. Interchange statuses are: 'OK' - Received successfully 'NA' - No valid data in interchange 'ER' - Valid with invalid data in interchange Messages statuses are: 'CP' - Translation successful 'CA' - Translation error 'CI' - Translation incomplete due to a fatal error during translation For both interchange and message the sequence number should be followed by the corresponding status, separated by a single space. The number of messages received is included only in the occurrence of the segment using qualifier RIS, and not in any occurrence using qualifier MIS. If the interchange status is "NA", the segment terminator should appear immediately after this status and no RFF segment with a Reference Qualifier of MIS should be included. In this case, no interchange sequence number or number of messages will be included in the RFF segment with a qualifier of RIS. Version: 1.5 Date: 03/04/00 Page: 15 of 26

16 If any message status is "CA" or "CI", the interchange status should be "ER". In this case, the message sequence number may not be available, and so may or may not be included in the RFF segment(s) with a qualifier of MIS. Version: 1.5 Date: 03/04/00 Page: 16 of 26

17 UNH MESSAGE HEADER To head, identify and specify a message. No Data Element and value/description Usage Format 0062 MESSAGE REFERENCE NUMBER M an Message Sequence Number S009 MESSAGE IDENTIFIER M 0065 Message type identifier M an..6 - RECEP 0052 Message type version number M an Message type release number M an Controlling agency M an..2 - FH 0057 Association assigned code N an COMMON ACCESS REFERENCE N an..35 S010 STATUS OF THE TRANSFER N 0070 Sequence message transfer number M n First/last sequence message transfer identification C a1 UNT MESSAGE TRAILER To end and check the completeness of a message. No Data Element and value/description Usage Format 0074 NUMBER OF SEGMENTS IN A MESSAGE M n..6 - Number of segments 0062 MESSAGE REFERENCE NUMBER - Message Sequence Number M an..14 Version: 1.5 Date: 03/04/00 Page: 17 of 26

18 7 EDIFACT Reference Directory 7.1 Formal definition of composites This following list of composite data elements are included in the latest TRIAL directory. C002 C082 C506 C507 S009 S010 DOCUMENT/MESSAGE NAME PARTY IDENTIFICATION DETAILS REFERENCE DATE/TIME/PERIOD MESSAGE IDENTIFIER STATUS OF TRANSFER Composite specifications The full definitions of the composite data elements are to be found in UNTDID part 5, chapter 3, UN/EDIFACT Data Segment Directory (EDCD). C002 DOCUMENT/MESSAGE NAME Identification of a type of document/message by code or name. Code preferred Document/message name, coded C an Code list qualifier C an Code list responsible agency, coded C an Textual equivalent of the associated coded representation C an..35 C082 PARTY IDENTIFICATION DETAILS Identification of a transaction party by code Party Id identification M an Code list qualifier C an Code list responsible agency,coded C an Textual equivalent of the associated coded representation C an..35 C506 REFERENCES Identification of a reference Reference qualifier M an Reference number C an Line number C an..6 Version: 1.5 Date: 03/04/00 Page: 18 of 26

19 C507 DATE/TIME/PERIOD Date and/or time relevant to the specified date/time type Date/time/period qualifier M an Date/time/period M an Date/time/period format qualifier M an.3 S009 MESSAGE IDENTIFIER Identification of the type, version etc. of the message being interchanged Message type identifier M an Message type version number M an Message type release number M an Controlling agency M an Association assigned code C an..6 S010 STATUS OF TRANSFER Statement that the message is one in a sequence of transfers relating to the same topic Sequence message transfer number M n First/last sequence message transfer identification C a1 Version: 1.5 Date: 03/04/00 Page: 19 of 26

20 7.2 Formal definition of data elements The following list of data elements are included in the 90.2 TRIAL directory CONTROLLING AGENCY 0052 MESSAGE TYPE VERSION NUMBER 0054 MESSAGE TYPE RELEASE NUMBER 0057 ASSOCIATION ASSIGNED CODE 0062 MESSAGE REFERENCE NUMBER 0065 MESSAGE TYPE IDENTIFIER 0068 COMMON ACCESS REFERENCE 0070 SEQUENCE MESSAGE TRANSFER NUMBER 0073 FIRST/LAST SEQUENCE MESSAGE TRANSFER INDICATION 0074 NUMBER OF SEGMENTS IN A MESSAGE 1001 DOCUMENT/MESSAGE NAME, CODED 1004 DOCUMENT/MESSAGE NUMBER 1131 CODE LIST QUALIFIER 1153 REFERENCE QUALIFIER 1154 REFERENCE NUMBER 1156 LINE NUMBER 1225 MESSAGE FUNCTION, CODED 2005 DATE/TIME/PERIOD QUALIFIER 2781 DATE/TIME/PERIOD FORMAT QUALIFIER 2782 DATE/TIME/PERIOD 3039 PARTY ID IDENTIFICATION 3055 CODE LIST RESPONSIBLE AGENCY, CODED 4343 RESPONSE TYPE, CODED 4774 TEXTUAL EQUIVALENT OF THE ASSOCIATED CODED REPR. Version: 1.5 Date: 03/04/00 Page: 20 of 26

21 Data element specifications The full definitions of the data elements are to be found in UNTDID part 5, chapter 3, UN/EDIFACT Data Segment Directory (EDED) CONTROLLING AGENCY Code identifying the agency controlling the specification, maintenance and publication of the message type. an MESSAGE TYPE VERSION NUMBER Version number of a message type. an MESSAGE TYPE RELEASE NUMBER Message type release number. an ASSOCIATION ASSIGNED CODE Code, assigned by the association responsible for the design and maintenance of the message type concerned, which further identifies the message. an MESSAGE REFERENCE NUMBER Unique message reference assigned by the sender. an MESSAGE TYPE IDENTIFIER Code identifying a type of message and assigned by its controlling agency. an COMMON ACCESS REFERENCE Reference serving as a key to relate all subsequent transfers of data to the same business case or file. an..35 Version: 1.5 Date: 03/04/00 Page: 21 of 26

22 0070 SEQUENCE MESSAGE TRANSFER NUMBER Number assigned by the sender indicating that the message is an addition or change of a previously sent message relating to the same topic. n FIRST/LAST SEQUENCE MESSAGE TRANSFER INDICATION Indication used for the first and last message in a sequence of the same type of message relating to the same topic. a NUMBER OF SEGMENTS IN A MESSAGE Control count of number of segments in a message. n DOCUMENT/MESSAGE NAME, CODED Document identifier expressed in code. an DOCUMENT/MESSAGE NUMBER Reference number assigned to the document by the issuer. an CODE LIST QUALIFIER Identification of a code list. an REFERENCE QUALIFIER Code giving specific meaning to a reference segment or a reference number. an REFERENCE NUMBER Identification number the nature and function of which can be qualified by and entry in data element 1153 Reference qualifier. an LINE NUMBER Version: 1.5 Date: 03/04/00 Page: 22 of 26

23 Number of the line in the document /message referenced in 1154 Reference number. In this message it is used to define a Job type. an MESSAGE FUNCTION, CODED Code indicating the function of the message. an DATE/TIME/PERIOD QUALIFIER Code giving specific meaning to a date, time or period. an DATE/TIME/PERIOD FORMAT QUALIFIER Specification of the representation of a date, time or period. an DATE/TIME/PERIOD The value of a date, a date and time, a time or of a period in a specified representation. an PARTY ID IDENTIFICATION Code identifying a party involved in a transaction. an CODE LIST RESPONSIBLE AGENCY, CODED Code identifying the agency responsible for a code list. an RESPONSE TYPE, CODED Code specifying the type of acknowledgment required. an TEXTUAL EQUIVALENT OF THE ASSOCIATED CODED REPR. Textual description adding to or replacing corresponding coded information. an..35 Version: 1.5 Date: 03/04/00 Page: 23 of 26

24 7.3 Data element code values 1131 CODE LIST QUALIFIER 814 GP local code: local code allocated by HA(FHSA) 819 Health Authority(FHSA) (2, 3 char) code 835 Screening Office code defined by the HA(FHSA) 837 Cytology laboratory code 859 Child Health Unit code 1153 REFERENCE QUALIFIER RIS MIS Received interchange sequence and status Received message sequence and status 1225 MESSAGE FUNCTION, CODED 64 Message receipt report 2005 DATE/TIME/PERIOD QUALIFIER 815 Receive date of interchange 2781 DATE/TIME/PERIOD FORMAT QUALIFIER 306 CCYYMMDDHHMM 3055 CODE LIST RESPONSIBLE AGENCY, CODED GB2 NHS Information Authority 201 NHS Information Authority 202 Local HA(FHSA) Version: 1.5 Date: 03/04/00 Page: 24 of 26

25 8 Examples of Receipt Reports The following example is of a receipt report sent from an HA (FHS1) to a GP practice (GP05), showing correct receipt of interchange , which contained messages , , , and UNB+UNOA:2+FHS1+GP : RECEP+++EDIFACT TRANSFER' UNH RECEP:0:2:FH' BGM : :306+64' NHS+FHS:819: :814:202' DTM+815: :306' RFF+MIS: CP' RFF+MIS: CP' RFF+MIS: CP' RFF+MIS: CP' RFF+RIS: OK:4' UNT ' UNZ ' The example below is of a receipt report sent from a Screening Office (SOF2) to an HA (FHS1), showing correct receipt of message and errored receipt of message , both in interchange UNB+UNOA:2+SOF2+FHS : RECEP+++EDIFACT TRANSFER' UNH RECEP:0:2:FH' BGM : :306+64' NHS+FHS:819:201+SOF' DTM+815: :306' RFF+MIS: CP' RFF+MIS: CA' RFF+RIS: ER:2' UNT ' UNZ ' Version: 1.5 Date: 03/04/00 Page: 25 of 26

26 The final example is of a receipt report sent from a Child Health Unit (CHU0) to an HA (FHS1), showing an error of no valid data received. UNB+UNOA:2+CHU0+FHS : RECEP+++A PROJECT' UNH RECEP:0:2:FH' BGM : :306+64' NHS+FHS:819:201+CHU' DTM+815: :306' RFF+RIS: NA' UNT ' UNZ ' Version: 1.5 Date: 03/04/00 Page: 26 of 26