Appendix 5 Conformance Statements (Normative)
Conformance Statements have been developed to help in formulating conformance testing of pathology messaging implementations in Australia against this Implementation Guide. The list below is not exhaustive. The entries are included here primarily if they:-
- are important from a safety or quality perspective, or
- are commonly not correctly implemented, or
- are at variance with the base HL7 v2.4 specifications.
Conformance of messages to base HL7 2.4 standards is otherwise assumed, and individual conformance tests or test applications may check against the base specification.
The following table indicates whether a conformance statement applies to a message sender, a message receiver, or both. In the case where a conformance statement applies to a message sender, it is expected that automated conformance checking can be carried out on one or more real or sample messages. For testing conformance of receiving implementations, the behaviour of the system must be observed in response to one or more real or sample messages.
The table of conformance statements indicates, for each statement, if it applies to order messages only, result messages only, or both.
Note: For the conformance points, generally the rule is stated first followed by the reason. The reason may also be referenced in other sections.
Note: HL7au Identifiers in () parenthesis are headings/groupers and not conformance points in themselves.
Conformance points which are revised will have their revision number in brackets after their HL7au identifier. For example HL7au:00000x.y.z (r2).
The values of Message Type Applicability column and their meanings are: -
- Orders = ORM messages
- Results = ORU messages
- Referrals = All REF messages (includes all profiles)
- Referrals(L1) = Simplified Referral Profile Level 1
- Referrals(L2) = Simplified Referral Profile Level 2
- Acknowledgement = ACK messages
- Referral Response = RRI messages
HL7au Identifier | Applicable to Senders/Receivers/Both | Message Type Applicability | Conformance point text | Comments |
---|---|---|---|---|
HL7au:000001 | Senders/Receivers | Orders | Order addressing - Senders and receivers must ensure an order message is addressed using MSH-6 Receiving facility, as per rules in sub points of HD Datatype conformance heading HL7au:00044.2. | |
HL7au:000001.1 | Receivers | Orders | The system must actively reject an order message where the MSH-6 Receiving Facility does not identify their organisation |
|
HL7au:000001.2 | Senders | Orders | When using SMD refer to HL7au:000044.2 otherwise; senders should address order messages in MSH-6 Receiving facility using the NATA number if available. | |
HL7au:000001.2.1 | Senders | Orders | In MSH-6 the namespace ID should contain the registered NATA name for the laboratory as published by NATA ( www.nata.com.au ) | |
HL7au:000002 (r2) | Receivers | Results, Referrals | The system receiving messages must ensure that any document identifiers (OBR-3 Filler order number (EI)) in the received message are fully specified, with the authoring organisation's HD qualifying the identifier. This is done by testing that all components of Entity Identifier (EI) are valued, and when not returning error acknowledgement. | Document updating depends on a reliable document identifier and without a namespace for the identifier safe updating/corrections to documents is not possible. |
HL7au:000003 (r2) | Senders | Orders, Results, Referrals | If OBR-2 is valued, then to ensure the uniqueness of the Entity Identifier (EI) in OBR-2 (Placer Order Number) for a request identifier across different organisations, the Entity identifier (first component) in addition to the Namespace ID (second component) and Universal ID (third component) and Universal ID type (4th component) must be populated. | field optionality is still allowed i.e. field may be completely unvalued |
HL7au:000004.1 (r3) | Senders | Orders, Results, Referrals | If OBR-3 is valued, then to ensure the uniqueness of the Entity Identifier (EI) in OBR-3 (Filler Order Number) for a result identifier across different organisations, the Entity identifier (first component) in addition to the Namespace ID (second component) and Universal ID (third component) and Universal ID type (4th component) must be populated. | It is vital that a unique identifier within the authoring facility HD is used in the first component. The ability to issue corrected documents depends on the uniqueness of this document identifier. Future updates to a document will use the same identifier in OBR-3. |
HL7au:000004.2 (r1) | Receivers | Orders, Results, Referral | Older results with identical Entity Identifier (EI) in OBR-3 (Filler Order Number) to that of a newly received result message (by comparing OBR-22 Rpt/Status Change Date/Time field) must be replaced with the new message, and the older marked as deleted/superseded. | This applies independently to each OBR/OBX group |
HL7au:000005 (r2) | Senders | Orders, Results, Referrals | If ORC-2 is valued, then to ensure the uniqueness of the Entity Identifier (EI) in ORC-2 (Placer Order Number) for a request identifier across different organisations, the Entity identifier (first component) in addition to the Namespace ID (second component) and Universal ID (third component) and Universal ID type (4th component) must be populated. | field optionality is still allowed i.e. field may be completely unvalued |
HL7au:000006 (r3) | Senders | Orders, Results | If ORC-3 is valued, then to ensure the uniqueness of the Entity Identifier (EI) in ORC-3 (Filler Order Number) for a result identifier across different organisations, the Entity identifier (first component) in addition to the Namespace ID (second component) and Universal ID (third component) and Universal ID type (4th component) must be populated. | |
HL7au:000007 (r2) | Senders | Orders, Results, Referrals | If ORC-4 is valued, then to ensure the uniqueness of the Entity Identifier (EI) in ORC-4 (Placer Group Number) for a request identifier across different organisations, the Entity identifier (first component) in addition to the Namespace ID (second component) and Universal ID (third component) and Universal ID type (4th component) must be populated. | field optionality is still allowed i.e. field may be completely unvalued |
(HL7au:000008) | Display Segments | |||
HL7au:000008 | Senders | Results, Referrals | The message must contain at least one OBX display segment per OBR/OBX group. | **wording updated, same intention |
HL7au:000008.1 (r2) | Senders | Results, Referrals | Display segments must use the appropriate valid values within the AUSPDI coding system in OBX-3 for the content that is represented in it:
(Referral Level 1 receivers are only required to support PDF display segments. See HL7au:000008.3.1) | |
HL7au:000008.1.1 (r4) | Receivers | Results, Referrals | For Referrals Level 1 Receivers must be capable of displaying PDF (either via an embedded viewer or an external viewer) For other profiles: Receivers should be capable of displaying all display formats HTML, PDF, RTF, TXT (HL7 FT) (either via an embedded viewer or an external viewer), and must provide users access to all of these in an external viewer application if they are unable to fully display the format. *This conformance point was relaxed 31/10/2017. | Some formats may be viewed with an embedded viewer and external viewer, while other formats may be viewed with just an external viewer e.g. RTF). It is important that all can be accessed and viewed. |
HL7au:000008.1.2 | Senders and Receivers | Results | An OBX display segment is identified using OBX-3 Identifier (CE-1) and Name of Coding System (CE-3) components. The text component of the CE may be blank and only CE1 and CE-3 components need to match. | |
HL7au:000008.1.3 | Senders and Receivers | Results | In an OBX display segment, the OBX-2 Value Type field must match its corresponding display format specified in OBX-3 Identifier (ST) component as per table Display Format codes in Section 4.5 Display Segments. | |
HL7au:000008.1.4 | Senders and Receivers | Results | In an OBX display segment, the OBX-3 <name of coding system (IS)> must be valued "AUSPDI". | |
HL7au:000008.1.5 | Senders | Results, Referrals | The OBX display segment(s) must be the last in a set of OBX segments in each OBR/OBX group, with the exception of digital signature OBX(s) which may be after the display segments OBXs. (Display segments can be identified by having AUSPDI OBX-3 <name of coding system>) | |
HL7au:000008.1.6 | Receivers | Results, Referrals | When a display segment is shown, the earlier atomic OBX segments must not be rendered. | |
HL7au:000008.2 | Senders | Results | There must NOT be conflicting content between the OBX display segment and the preceding OBX atomic data. A compliant rendering of the atomic data (if present) must contain the same clinical information. |
|
HL7au:000008.2.1 | Senders | Referrals | For OBX within the supporting information OBR/OBX groups. There must NOT be conflicting content between the OBX display segment and the preceding OBX atomic data. A compliant rendering of the atomic data (if present) must contain the same clinical information. | |
HL7au:000008.2.2 | Senders | Referrals | For OBX within the current summary OBR/OBX group as indicated by OBR-4 as per section 4.4.1.4.1 OBR-4 codes in referral messages. There must NOT be conflicting content between the OBX display segment and the preceding OBX atomic data and the medication and allergy segments of the REF message. | |
HL7au:000008.3.1 | Senders | Referrals | For Referrals Level 1: The single OBR/OBX group of the message must contain an OBX display segment in PDF format. For other profiles: Each OBR/OBX group of the message must contain at least one of the following OBX display segments HTML, PDF, TXT (HL7 FT). | |
HL7au:000008.3.2 | Senders | Referrals(L2) | If an RTF display segment is sent in an OBR/OBX group, then the same content must be sent in one of either HTML, PDF, or TXT (HL7 FT) same OBR/OBX group. | |
(HL7au:000008.2.3) | XHTML Display Segment | |||
(HL7au:000008.2.3.1) | XHTML Display Segment - Sender | |||
HL7au:000008.2.3.1.01 | Senders | Results, Referrals | Any OBX HTML display segments must be valid HTML and conform to the Document Type defined in 'XHTML 1.0 Strict' standard. Refer to http://validator.w3.org/ to validate XHTML content. | |
HL7au:000008.2.3.1.02 | Senders | Results, Referrals | All embedded hyperlinks must be secure hyperlinks i.e. https:// . That is http:// is disallowed. | |
HL7au:000008.2.3.1.03 | Senders | Results, Referrals | Sender must not use external style sheets. Internal style sheets are allowed. Note: external stylesheets are a security risk and could affect presentation of content. | |
HL7au:000008.2.3.1.04 | Senders | Results, Referrals | Sender must not use scripts e.g. JavaScript etc. Note: active content is not allowed either inline or as external references. | |
HL7au:000008.2.3.1.05 | Senders | Results, Referrals | Sender must not use the following elements:
| |
HL7au:000008.2.3.1.06 | Senders | Results, Referrals | If there is an image map, senders must have an additional mechanism for communicating that information because there is no obligation on receiving systems to deal with image maps. | |
HL7au:000008.2.3.1.07 | Senders | Results, Referrals | Embedded CSS shall conform to the CSS3 specification. | |
HL7au:000008.2.3.1.08 | Senders | Results, Referrals | The core display of the report must be encapsulated in a 'div' element of html class ‘reportDisplay’. | |
HL7au:000008.2.3.1.09 | Senders | Results, Referrals | Letter head information should be encapsulated in XHTML elements outside of the scope of the core display of the report identified by 'div' html class 'reportDisplay'. | |
HL7au:000008.2.3.1.10 | Senders | Results, Referrals | Letter head images may not be embedded in the html but served externally. | |
HL7au:000008.2.3.1.11 | Senders | Results, Referrals | External letter head image sources must not be used, except when used outside a 'div' 'reportDisplay' class html element and only when that 'div' it is present.
| |
HL7au:000008.2.3.1.12 | Senders | Results, Referrals | The core report must display in a readable way with the CSS removed. | |
HL7au:000008.2.3.1.13 | Senders | Results, Referrals | Information in the core report data must not be hidden by CSS formatting directives. | |
HL7au:000008.2.3.1.14 | Senders | Results, Referrals | Image element "src" attributes must use the value "hl7v2://OBX.<setID>" where the setID reference the OBX in the message containing the Encapsulated Data (ED) image or Reference Pointer (RP) to the data, except for images which are a part of a letterhead as per HL7au:000008.2.3.1.10. | |
HL7au:000008.2.3.1.15 | Senders | Results, Referrals | External images may be linked from the report body via a clickable link which the user can manually select. | e.g. to access a PACS image |
(HL7au:000008.2.3.2) | XHTML Display segment - Receiver | |||
HL7au:000008.2.3.2.01 | Receivers | Results, Referrals(L2) | HTML display segments must be displayed using a HTML/CSS component that is compliant for rendering of XHTML and CSS3. | |
HL7au:000008.2.3.2.03 | Receivers | Results, Referrals(L2) | Secure hyperlinks (https://) must be able to be clicked by a user and client application must enable navigation to secure https:// sites . | |
HL7au:000008.2.3.2.04 | Receivers | Results, Referrals(L2) | Receiving software may filter or disable all embedded JavaScript. | |
HL7au:000008.2.3.2.05 | Receivers | Results, Referrals(L2) | Receiving software may suppress objects, iframes, forms with base/link/xlink | |
HL7au:000008.2.3.2.06 | Receivers | Results, Referrals(L2) | Receiving software may block access to insecure hyperlinks e.g. file://, http:// | |
HL7au:000008.2.3.2.07 | Receivers | Results, Referrals(L2) | It should be possible for users in receiving software to selectively hide content outside of the 'div' element of html class ‘reportDisplay’. | |
HL7au:000008.2.3.2.08 | Receivers | Results, Referrals(L2) | Receiving software should not selectively hide any html when no 'div' element of html class ‘reportDisplay’ is not present in XHTML content. | |
HL7au:000008.2.3.2.02 | Receivers | Results, Referrals(L2) | Receiver must support embedded images in XHTML that must be proper URLs suitable for browser use directly, or use the HL7 V2: scheme defined in the HTML Appendix. | Receivers may choose to parse the xml and replace the hl7v2 scheme content with a base64 encoded image from the appropriate OBX. eg.
|
HL7au:000008.2.3.2.09 | Receivers | Results, Referrals(L2) | XHTML containing images with a source referring back to an RP OBX segment using the 'hl7v2://OBX.<setID>' must be resolved so that the images are viewable. | ** Note that regular browsers do not support this feature directly, xhtml preprocessing is required before display with browser |
HL7au:000008.2.3.2.10 | Receivers | Results, Referrals(L2) | XHTML containing images with a source referring back to an ED OBX segment using the 'hl7v2://OBX.<setID>' must be resolved so that the images are viewable. | ** Note that regular browsers do not support this feature directly, xhtml preprocessing is required before display with browser |
(HL7au:000008.2.4) | PDF Display segment | |||
(HL7au:000008.2.4.1) | PDF Display segment - Sender | |||
HL7au:000008.2.4.1.1 | Senders | Results, Referrals | Documents must be valid according to the PDF/A-1b profile. | |
HL7au:000008.2.4.1.2 | Senders | Results, Referrals | Must embed fonts | |
HL7au:000008.2.4.1.3 | Senders | Results, Referrals | Must not use encryption/password protection | |
HL7au:000008.2.4.1.4 | Senders | Results, Referrals | Must not use PDF Comments | |
HL7au:000008.2.4.1.5 | Senders | Results, Referrals | Must not restrict printing. | |
HL7au:000008.2.4.1.6 | Senders | Results, Referrals | Must not restrict copying. | |
HL7au:000008.2.4.1.7 | Senders | Results, Referrals | May use PDF digital signature | |
HL7au:000008.2.4.1.8 | Senders | Results, Referrals | May use PDF restrict changes | |
HL7au:000008.2.4.1.9 | Senders | Results, Referrals | May use PDF compression | |
(HL7au:000008.2.4.2) | PDF Display segment - Receiver | |||
HL7au:000008.2.4.2.1 | Receivers | Results, Referrals | Receiver software must display the received PDF with a PDF viewer component. | |
HL7au:000008.2.4.2.2 | Receivers | Results, Referrals | Receiver software must be capable of rendering PDF/A-1b content. | |
HL7au:000008.2.4.2.3 | Receivers | Results, Referrals | Receiver must support embedded fonts. This is because content is laid out based on font metrics. | |
HL7au:000008.2.4.2.4 | Receivers | Results, Referrals | Receiver must support PDF compression. | |
HL7au:000008.2.4.2.5 | Receivers | Results, Referrals | Receivers may validate for PDF digital signatures. | |
HL7au:000008.2.4.2.6 | Receivers | Results, Referrals | Receiver software must not allow changes to documents in all circumstances. This is irrespective of PDF flags to restrict changes. | |
(HL7au:000008.2.4.3) | RTF Display segment | |||
(HL7au:000008.2.4.3.1) | RTF Display segment - Sender | |||
HL7au:000008.2.4.3.1.1 | Senders | Results, Referrals | RTF must not contain nested tables (i.e. tables inside tables) | |
HL7au:000008.2.4.3.1.2 | Senders | Results, Referrals | RTF must not contain active content such as Objected Linking and Embedding Objects (OLE), except with image rendition subject to site-specific negotiation. | |
HL7au:000008.2.4.3.1.3 | Senders | Results, Referrals | RTF must not contain embedded fonts | |
HL7au:000008.2.4.3.1.4 | Senders | Results, Referrals | RTF must not contain smart shapes/other drawing objects (convert these to PNG images) | |
HL7au:000008.2.4.3.1.5 | Senders | Results, Referrals | RTF must not contain smart tags | |
HL7au:000008.2.4.3.1.6 | Senders | Results, Referrals | RTF must not contain change tracking markup or comments | |
HL7au:000008.2.4.3.1.7 | Senders | Results, Referrals | RTF must not contain section specific page layout | |
HL7au:000008.2.4.3.1.8 | Senders | Results, Referrals | RTF must not contain word forms | |
HL7au:000008.2.4.3.1.9 | Senders | Results, Referrals | Clinical information must not be presented in Header/footer/cross-references. | |
HL7au:000008.2.4.3.1.10 | Senders | Results, Referrals | Branding information may be presented in Header/footer/cross-references. | |
HL7au:000008.2.4.3.1.11 | Senders | Results, Referrals | Watermark must not be required to be viewed. | |
HL7au:000008.2.4.3.1.12 | Senders | Results, Referrals | All field values are up to date, as fields may not updated, only displayed as text. | |
(HL7au:000008.2.4.3.2) | RTF Display segment - Receiver | |||
Note: Referral receivers may choose to support the required RTF receiver capability by allowing the user to launching a compliant external RTF viewer application (such as Microsoft Word Viewer / Microsoft Word). It is not a requirement to embed a viewer. | ||||
HL7au:000008.2.4.3.2.01 | Receivers | Results, Referrals(L2) | Receivers must process the \binXXXX control word and skip processing of RTF control words for XXX bytes. | Refer to Word 2007: Rich Text Format (RTF) Specification, version 1.9.1 page 211 where it says "the reader must explicitly check each control word found to see if it is a \binN control, and if found, skip that many bytes before resuming its scanning for braces." |
HL7au:000008.2.4.3.2.02 | Receivers | Results, Referrals(L2) | Receivers must support tables, except for nested tables | |
HL7au:000008.2.4.3.2.03 | Receivers | Results, Referrals(L2) | Receivers must support hyperlinks | |
HL7au:000008.2.4.3.2.04 | Receivers | Results, Referrals(L2) | Receivers must allow secure https:// hyperlinks to be clickable and navigable into a web browser. | |
HL7au:000008.2.4.3.2.05 | Receivers | Results, Referrals(L2) | Receivers must support display of RTF embedded bmp, gif, png, jpg, and emf. | |
HL7au:000008.2.4.3.2.06 | Receivers | Results, Referrals(L2) | Receivers must support display of RTF columns | |
HL7au:000008.2.4.3.2.07 | Receivers | Results, Referrals(L2) | Receivers must support Lists including bullet and numbers. | |
HL7au:000008.2.4.3.2.08 | Receivers | Results, Referrals(L2) | Receivers must support display of nested lists with indication of logical nesting. | |
HL7au:000008.2.4.3.2.09 | Receivers | Results, Referrals(L2) | Display of selected field values. | Editors such as Microsoft Word allow form fields to be created such as combo boxes, radio buttons and check boxes which users can select a value from. This the selected field value refers to the answer which should be present in the RTF field. |
HL7au:000008.2.4.3.2.10 | Receivers | Results, Referrals(L2) | Receivers may support Header/footer/cross-references | |
HL7au:000008.2.4.3.2.11 | Receivers | Results, Referrals(L2) | Receivers may support watermarks | |
HL7au:000008.2.4.3.2.12 | Receivers | Results, Referrals(L2) | Receivers must display field values. | This refers to fields such as page numbers. RTF senders should include the value in the field. |
HL7au:000008.2.4.3.2.13 | Receivers | Results, Referrals(L2) | Receivers may not calculate field values. | |
(HL7au:000008.2.4.4) | FT Display segment | |||
(HL7au:000008.2.4.4.1) | FT Display segment - Sender | |||
HL7au:000008.2.4.4.1.01 | Senders | Results, Referrals | Senders must escape '|' character to the field separator character escape sequence "\F\" | |
HL7au:000008.2.4.4.1.02 | Senders | Results, Referrals | Senders must escape '^' character to the component separator character escape sequence "\S\" | |
HL7au:000008.2.4.4.1.03 | Senders | Results, Referrals | Senders must escape '&' character to the sub-component separator character escape sequence "\T\" | |
HL7au:000008.2.4.4.1.04 | Senders | Results, Referrals | Senders must escape '~' character to the repeat character escape sequence "\R\" | |
HL7au:000008.2.4.4.1.05 | Senders | Results, Referrals | Senders must escape '\' character to the escape character escape sequence "\E\" | |
HL7au:000008.2.4.4.1.06 | Senders | Results, Referrals | Senders must escape new line character(s) to the escape sequence "\.br\" | |
HL7au:000008.2.4.4.1.07 | Senders | Results, Referrals | Senders must design FT content for presentation with a monospaced font | |
HL7au:000008.2.4.4.1.08 | Senders | Results, Referrals | Senders must not use "\Xdddd...\" hexadecimal data escape sequences | |
HL7au:000008.2.4.4.1.09 | Senders | Results, Referrals | Senders must not use "\Zdddd..\" locally defined escape sequences | |
HL7au:000008.2.4.4.1.10 | Senders | Results, Referrals | Senders must not use "\.ce\" escape sequences. | |
HL7au:000008.2.4.4.1.11 | Senders | Results, Referrals | Senders must not break FT content into multiple components or repeats. | |
HL7au:000008.2.4.4.1.12 | Senders | Results, Referrals | Senders must limit intended display line lengths to 80 characters. | |
HL7au:000008.2.4.4.1.13 | Senders | Results, Referrals | Senders must not use "\M" escape sequences. | |
HL7au:000008.2.4.4.1.14 | Senders | Results, Referrals | Senders must not use "\C" escape sequences. | |
(HL7au:000008.2.4.4.2) | FT Display segment - Receiver | |||
HL7au:000008.2.4.4.2.01 | Receivers | Results, Referrals(L2) | FT datatype content SHALL be displayed using monospaced font | |
HL7au:000008.2.4.4.2.02 | Receivers | Results, Referrals(L2) | Receivers must de-escape "\F\" to the field separator character '|' |
|
HL7au:000008.2.4.4.2.03 | Receivers | Results, Referrals(L2) | Receivers must de-escape "\S\" to the component separator character '^' | |
HL7au:000008.2.4.4.2.04 | Receivers | Results, Referrals(L2) | Receivers must de-escape "\T\" to the sub-component separator character '&' | |
HL7au:000008.2.4.4.2.05 | Receivers | Results, Referrals(L2) | Receivers must de-escape "\R\" to the repetition character '~' | |
HL7au:000008.2.4.4.2.06 | Receivers | Results, Referrals(L2) | Receivers must de-escape "\E\" to the escape character '\' | |
HL7au:000008.2.4.4.2.07 | Receivers | Results, Referrals(L2) | Receivers must start highlighting text whenever "\H\" escape sequence is encountered | |
HL7au:000008.2.4.4.2.08 | Receivers | Results, Referrals(L2) | Receivers must end highlighting text whenever "\N\" escape sequence is encountered. | |
HL7au:000008.2.4.4.2.09 | Receivers | Results, Referrals(L2) | Receivers must support "\.sp <number>\" escape sequences, and must maintain horizontal position while skipping positive <number> vertical spaces. (If <number> is not specified 1 must be assumed). | |
HL7au:000008.2.4.4.2.10 | Receivers | Results, Referrals(L2) | Receivers must support "\.br\" escape sequence and must begin a new left justified line. | |
HL7au:000008.2.4.4.2.11 | Receivers | Results, Referrals(L2) | Receivers must support the fill mode (word wrap) "\.fi\" escape sequence. This means that after this sequence is encountered a soft line break must be introduced when horizontal space runs out. | |
HL7au:000008.2.4.4.2.12 | Receivers | Results, Referrals(L2) | Receivers must support the no fill mode (no word wrap) "\.nf\" escape sequence. This means after this sequence is encountered a soft line break must not be introduced when horizontal space runs out. | |
HL7au:000008.2.4.4.2.13 | Receivers | Results, Referrals(L2) | Receivers must support indent "\.in <number>\" escape sequences. This means that on encountering this sequence each subsequent new line should be indented by positive <number> characters until the end of the document or another indent escape sequence sets the indent state. | |
HL7au:000008.2.4.4.2.14 | Receivers | Results, Referrals(L2) | Receivers must support temporary indent "\.ti <number>\" escape sequences. This means that on encountering this sequence the first character of the each line in the paragraph (i.e. until \.br\ is encountered) will be indented to the absolute <number> value of fixed-width characters from the left hand side (not relative to the current .in value). | |
HL7au:000008.2.4.4.2.15 | Receivers | Results, Referrals(L2) | Receivers must support skip "\.sk <number>\" escape sequences. This means that on encountering a skip sequence that the next character position will be advanced by <number> spaces to the right. | |
HL7au:000008.2.4.4.2.16 | Receivers | Results, Referrals(L2) | Receivers must ensure that 80 characters of text (using a non-proportional font) can be displayed without word wrapping the line of text. | |
HL7au:000008.2.4.4.2.17 | Receivers | Results | Receivers must support 8859/1 character encoding when specified in MSH-18. | |
(HL7au:000010) | Digital signatures | |||
HL7au:000010 | Receivers | Orders, Results, Referrals(L2) | If a digital signature is received in an OBX segment, receiving systems must recognise the digital signature and not inadvertently process it as data for display. | Refer to Standards Australia publication HB 308HB 308 - Location of Digital Signatures in HL7v2 Digital signature OBX can identified by OBX-3 (CE) identifier component starting with "AUSETAV", and OBX-3 name of code system component "L") |
HL7au:000010.1 | Receivers | Orders, Results, Referrals(L2) | If a digital signature is received in an OBX segment, then the signature and report content should if possible be verified and the results presented to the user on the display with the report. | |
HL7au:000019 | Senders and Receivers | Orders, Results, Referrals(L2) | A single message of up to 16 MB (16,777,216 bytes) must be able to be received by both the transmitters and receivers of messages. Note: Larger sized messages are feasible, but only under specific trading partner agreements. | |
HL7au:000020 | Senders | Orders, Results, Referrals(L2) | All message types and trigger event codes beginning with the letter “Z” are reserved for locally-defined messages and must NOT be used. |
|
HL7au:000021 | Senders | Results, Referrals(L2) | Data type TX must NOT be used as a value in the OBX-2 Value Type field. |
|
(HL7au:000022) | File and Batch Segments | |||
HL7au:000022.1 | Senders | Orders, Results, Referrals | If the batch header is used it must specify individual message acknowledgement. No information from the file header/footer or batch segments must be used. | |
HL7au:000022.2 | Receivers | Orders, Results | All messages between the batch header (BHS) and the file trailer (FTS) must be acknowledged individually. The batch itself is not acknowledged. |
|
HL7au:000022.3 | Senders | Referrals | Senders must generate batches containing no more than 1 message. | |
HL7au:000022.4 | Receivers | Orders, Results, Referrals | Receivers must support receiving messages contained inside HL7 batch protocol or a stand alone HL7 message. | |
HL7au:000023 | Senders | Orders, Results, Referrals | The NTE segment must NOT be used in messages. |
|
HL7au:000023.1 | Senders | Orders, Results, Referrals | User defined segments (Z segments) must not be used in messages. | |
(HL7au:000024) | Delimiters of ‘|^~\&’ from HL7 V2.4 must be used in the message. |
| ||
HL7au:000024.1 | Senders | Orders, Results, Referrals | FHS, BHS, and MSH segments must specify the Field separator character as '|' | |
HL7au:000024.2 | Senders | Orders, Results, Referrals | FHS, BHS, and MSH segments must specify the Components separator character as '^' | |
HL7au:000024.3 | Senders | Orders, Results | FHS, BHS, and MSH segments must specify the Sub-components separator characters '&' | |
HL7au:000024.4 | Senders | Orders, Results | FHS, BHS, and MSH segments must specify the repeat separator character as '~' | |
HL7au:000024.5 | Senders | Orders, Results | FHS, BHS, and MSH segments must specify the escape separator character as '\' | |
General Conformance Points | ||||
HL7au:000025 | Senders | Orders, Results, Referrals | The sending facility must ensure their MSH-4 Sending facility identifier is unique. | |
HL7au:000025.1.1 | Receivers | Results, Referrals, Orders | Intended recipients which are Healthcare Services or inactive providers must be managed by the receiving system to ensure the message content is reviewed for triage. | |
HL7au:000025.1.2 | Receivers | Results, Referrals, Orders | Received messages without an intended recipient which must be managed by the receiving system to ensure the message content is reviewed for triage. | |
HL7au:000026 | Senders | Results | When sending a report to multiple "copy to " doctors the MSH-10 Message control ID must be unique in each message produced for each recipient. | |
HL7au:000026.2 | Senders | Referrals | When sending copies of the same referral to multiple providers, the MSH-10 Message control ID must be unique in each message produced for each recipient, and the PRD "IR: Intended recipient role must be set appropriately for the intended recipient for each message. | |
HL7au:000027 | Senders | Orders, Results, Referrals | When re-transmitting a message the MSH-10 Message control ID must be unique. | |
HL7au:000028 | Senders | Results | When there are multiple OBR segments in an ORU message, the OBR-3 Filler order number must be unique within messages. | |
HL7au:000028.2 | Senders | Referrals | When there are multiple OBR/OBX groups in a REF message, each OBR-3 Filler order number pair must be unique for each OBR/OBX group. | |
HL7au:000029 | Senders | Results, Referrals | When re-transmitting/forwarding a message content from one system to another the MSH-4 Sending facility must be the re-transmitting/forwarding Sending facility (HD components) and not the original authoring organisation (HD components). | |
HL7au:000030 | Senders | Results, Referrals | When re-transmitting/forwarding a message's content from one system to another the MSH-10 Message control ID must be unique for each message. | |
HL7au:000031 | Senders | Results, Referrals | When re-transmitting/forwarding a message's content from one system to another OBR-3.2 Filler order number.namespace ID must be used for the display of the authoring organisation e.g. |123456^Path Lab Name^43210^AUSNATA|. The Filler order number of a result must not be changed. | |
HL7au:000032 | Senders | Results | In the ORU message the field OBR-24 "Diagnostic serv sect ID" must be valued and must have values from HL7 table 0074 - diagnostic service section. | |
HL7au:000032.2 | Senders | Referrals | In the REF message the field OBR-24 "Diagnostic serv sect ID" must be valued and must have values from HL7 table 0074 - diagnostic service section appropriate for the content in the OBR/OBX group. | |
HL7au:000032.3 | Receivers | Results, Referrals | If the receiving system has a various categories for their inbound communications in their application. eg. Letters, Radiology, then each OBR/OBX group content must be added to those by classifying the OBR/OBX group content based on OBR-24 value. PHY, LAB, RAD are the most common ones. The system must map each value in HL7 Table 0074 - Diagnostic service section ID to the appropriate category. | |
HL7au:000033 | Senders | Results | In Pathology ORU messages the field OBX-3 "Observation identifier" should, if possible, have values from the LOINC coding system except for display segments and digital signature OBX. | |
(HL7au:000034) | Use of Codes | |||
HL7au:000034.1 | Senders | Results, Referrals | When using CE, CWE, CNE data types in an OBX segment in either OBX-3 (Observation Identifier) or as an Observation Value, if the system transmits both the public (e.g. LOINC) and local terminology, then the public (e.g. LOINC) code must appear in the identifier. | |
HL7au:000034.2 | Senders | Results, Referrals | When using CE, CWE, CNE data types in an OBX segment, in OBX-3 (Observation Identifier), if the system transmits both a public (e.g. LOINC) and a local terminology, then the local terminology must be transmitted in the second CE triplet i.e. the alternate identifier. | |
HL7au:000034.3 | Senders | Results, Referrals | When using CE, CWE, CNE data types in an OBX segment, In either OBX-3 (Observation Identifier) or as an Observation Value, if the system transmits both a public (e.g. LOINC) and a local terminology, then concepts from the different terminologies must convey the same clinical meaning. Generally this means there is no need to populate the Alternate Text field. | |
HL7au:000034.4 | Receivers | Results | Receivers must recognize Result and Report comment LOINC codes and Template ID/Section Header LOINC codes and display appropriately. | See 4.6 Specific LOINC codes |
(HL7au:000040) | MSH-12 Version ID Field Conformance Points | |||
HL7au:000040.1 | Senders | Orders, Results, Referrals, ACK, RRI | Senders conforming to this specification must specify "2.4" as the value of version ID (ID) component of MSH-12 Version ID (VID) | |
HL7au:000040.2 (r2) | Senders | Orders, Results, Referrals, ACK, RRI | MSH-12 Version ID <internationalization code (CE)> component must be valued "AUS&Australia&ISO3166_1" | |
HL7au:000040.3 | Senders | Orders, Results | MSH-12 Version ID <internal version ID (CE)> component must be valued as "HL7AU-OO-201701&&L". (Note that the number scheme used in this identifier is HL7 date format: YYYYMM) | ** errata |
HL7au:000040.4 (r2) | Senders | Referrals, RRI | MSH-12 Version ID <internal version ID (CE)> component must be valued as " "HL7AU-OO-REF-SIMPLIFIED-201706-L1&&L" (for Level 1). (Note that the number scheme used in this identifier is HL7 date format: YYYYMM) | The RRI should echo the received MSH-12 <internal version (ID)>. This is a hint to the SMD agent as to the service category to be used. |
HL7au:000040.5 | Receivers | Orders, Results, Referrals | Receiving systems must use MSH-12 to affect the behaviour of message processing, when supporting various versions of the HL7 message standards and profiles. | |
HL7au:000041 (r2) | Senders | Orders, Results, Referrals, ACK, RRI | The country of origin of the message must be specified in MSH-17 Country code. For Australian originators the value must be "AUS". | |
HL7au:000042 | Senders | Orders, Results, Referrals, ACK, RRI | MSH-19 must be valued as "en^English^ISO639". | |
(HL7au:000043) | MSH-4 Sending Facility conformance points | |||
HL7au:000043.1 | Senders | Orders, Results, Referrals | MSH-4 – Sending Facility must be filled in with the sending facility HPI-O when sending a message via Secure Message Delivery (SMD) and secured by NASH Certificates. The format must be "registered organisation name in HI service^1.2.36.1.2001.1003.0.<hpio>^ISO" where <hpio> is a 16-digit number. The identifier is essentially used to locate the endpoint of the sending facility and will be used by the receiving facility to return an acknowledgement. | ** errata was inconsistent with 44.2.1 |
HL7au:00043.2 | Receivers | Orders, Results, Referrals | MSH-4 – Sending Facility when using SMD with NASH certificates must be validated against the SMD sending organisation. The message must be rejected if the SMD certificate does not match. (This is an anti spoofing check) | ** This conformance point applies only to SMD Agent implementers, this check should be performed before handing off a the message to the receiving system. |
HL7au:00043.3 (r2) | Senders | Orders, Results, Referrals | When SMD is used with vendor based certificates and identifiers, then the components of the MSH-4 HD must match with content of the sender as valued in the provider directory and also as identified in the sender's X.509 certificate. | |
HL7au:00043.4 (r2) | Senders | Orders, Results, Referrals | When SMD is used with vendor based certificates and identifiers, then the components of the MSH-6 HD must match with content of the receiver as valued in the provider directory and also as identified in the receiver's X.509 certificate. | need detailed component mapping from directory and x.509 certs |
(HL7au:00044) | Datatype conformance points | |||
HL7au:00044.0.1 | Senders | Orders, Results, Referrals | User defined datatypes are prohibited in all segment fields, components, and subcomponents. (Note that this prohibits the use of user defined datatypes in variable datatype fields such as OBX-5). | |
(HL7au:00044.1) | CX datatype conformance points | |||
HL7au:00044.1.1 | Senders | Orders, Results, Referrals | CX <ID (ST)> component must be specified and valid according to the identifier scheme of selected by the Identifier type code and Assigning Authority components. | |
HL7au:00044.1.2 (r2) | Senders | Orders, Results, Referrals | CX <assigning authority (HD)> component must be valued and must conform to sub points of HL7au:00044.2. | |
HL7au:00044.1.3 | Senders | Orders, Results, Referrals | CX <identifier type code (ID)> component must be valued with a valid value from HL7 Table 0203 - Identifier type. | |
(HL7au:00044.2) | HD Datatype conformance points for MSH-4, and MSH-6 | |||
HL7au:00044.2.1 (r2) | Senders | Orders, Results, Referrals | When using SMD with NASH certificates the HD Namespace ID component must contain the registered organisation name as registered by in the Medicare Australia HPOS/HI service. | |
HL7au:00044.2.2 (r2) | Senders | Orders, Results, Referrals | When using SMD with NASH certificates the HD Universal ID component must contain the HPI-O formatted as "1.2.36.1.2001.1003.0." concatenated with the HPI-O. | |
HL7au:00044.2.3 (r2) | Senders | Orders, Results, Referrals | When using SMD with NASH certificates the HD Universal ID Type component must be "ISO". | |
HL7au:00044.2.4 | Senders | Orders, Results, Referrals | When SMD is used with vendor based certificates and identifiers, then the components of the HD must match with content of the receiver as valued in the provider directory and also as identified in the organisation's X.509 certificate. | |
(HL7au:00044.3) | EI datatype conformance points | |||
HL7au:00044.3.1 (r2) | Senders | Orders, Results, Referrals | The EI Entity identifier component must be valued and for each document/report must be unique within the sender facility namespace (HD). | |
HL7au:00044.3.2 (r2) | Senders | Orders, Results, Referrals | When using SMD with NASH certificates the EI Namespace ID component must contain the registered organisation name as registered by in the Medicare Australia HPOS/HI service. | |
HL7au:00044.3.4 (r2) | Senders | Orders, Results, Referrals | When using SMD with NASH certificates the EI Universal ID component must contain the HPI-O formatted as "1.2.36.1.2001.1003.0." concatenated with the HPI-O. | |
HL7au:00044.3.3 (r2) | Senders | Orders, Results, Referrals | When using SMD with NASH certificates the EI Universal ID Type component must be "ISO". | |
HL7au:00044.3.4 | Senders | Orders, Results, Referrals | When SMD is used with vendor based certificates and identifiers, then the components of the HD must match with content of the receiver as valued in the provider directory and also as identified in the organisation's X.509 certificate. | |
(HL7au:00044.4) | CE datatype conformance points | |||
HL7au:00044.4.1 | Senders | Orders, Results, Referrals | When an <identifier (ST)> component is specified, the <name of the coding system> must also be specified. | |
HL7au:00044.4.2 | Senders | Orders, Results, Referrals | If no <identifier (ST)> component is specified then no <name of coding system> (primary coding system) must be specified | |
HL7au:00044.4.3 | Senders | Orders, Results, Referrals | <text (ST)> component must be valued as what is intended for display to the user. (In some locations user display is not intended and the text may be blank.) | |
HL7au:00044.4.4 | Senders | Orders, Results | When multiple codes are used LOINC codes (LN) must be placed first using the identifier rather than the alternate identifier. | |
HL7au:00044.4.5 | Senders | Orders, Results, Referrals | When an <alternate identifier (ST)> component is specified, the <name of alternate coding system> must also be specified. | |
HL7au:00044.4.6 | Senders | Orders, Results, Referrals | If no <alternate identifier (ST)> component is specified then no <name of alternate coding system> must be specified | |
HL7au:00044.4.7 | Senders | Orders, Results, Referrals | Both <identifier> and <alternative identifier> must reflect the same concept in each of the primary and alternate coding system respectively. Each code may reflect differing levels of granularity within each coding system as the level of granularity differs between coding systems. | |
HL7au:00044.4.8 | Senders | Orders, Results, Referrals | Alternate coding system must be a different from the primary coding system. As the two codes must describe the same concept the alternate text is optional. | |
(HL7au:00044.5) | CNE datatype conformance points | |||
HL7au:00044.5.1 | Senders | Orders, Results, Referrals | An <identifier (ST)> component is specified, the <name of the coding system> must also be specified. | |
HL7au:00044.5.2 | Senders | Orders, Results, Referrals | If no <identifier (ST)> component is specified then no <name of coding system> must be specified | |
HL7au:00044.5.3 | Senders | Orders, Results, Referrals | <text (ST)> component must be valued and this must be what is intended for display to the user. | |
HL7au:00044.5.4 | Senders | Orders, Results, Referrals | When an <alternate identifier (ST)> component is specified, the <name of alternate coding system> must also be specified. | |
HL7au:00044.5.5 | Senders | Orders, Results, Referrals | If no <alternate identifier (ST)> component is specified then no <name of alternate coding system> must be specified | |
HL7au:00044.5.6 (r2) | Senders | Orders, Results, Referrals | Removed | |
HL7au:00044.5.7 | Senders | Orders, Results, Referrals | Both <identifier> and <alternative identifier> must reflect the same concept in each of the primary and alternate coding system respectively. Each code may reflect differing levels of granularity within each coding system as the level of granularity differs between coding systems. | |
(HL7au:00044.6) | CWE datatype conformance points | |||
HL7au:00044.6.1 | Senders | Orders, Results, Referrals | When an <identifier (ST)> component is specified, the <name of the coding system> must also be specified. | |
HL7au:00044.6.2 | Senders | Orders, Results, Referrals | If no <identifier (ST)> component is specified then no <name of coding system> must be specified | |
HL7au:00044.6.3 | Senders | Orders, Results, Referrals | <text (ST)> component must be valued and this must be what is intended for display to the user. | |
HL7au:00044.6.4 | Senders | Orders, Results, Referrals | When an <alternate identifier (ST)> component is specified, the <name of alternate coding system> must also be specified. | |
HL7au:00044.6.5 | Senders | Orders, Results, Referrals | If no <alternate identifier (ST)> component is specified then no <name of alternate coding system> must be specified | |
HL7au:00044.6.6 (r2) | Senders | Orders, Results, Referrals | Removed | |
HL7au:00044.6.7 | Senders | Orders, Results, Referrals | Both <identifier> and <alternative identifier> must reflect the same concept in each of the primary and alternate coding system respectively. Each code may reflect differing levels of granularity within each coding system as the level of granularity differs between coding systems. | |
(HL7au:00044.7) | XCN datatype conformance points | |||
HL7au:00044.7.1 | Senders | Orders, Results, Referrals | XCN <ID (ST)> component must be specified and valid according to the identifier scheme of selected by the Identifier type code and Assigning Authority components. | |
HL7au:00044.7.2 | Senders | Orders, Results, Referrals | XCN <assigning authority (HD)> component must be valued and valid. | |
HL7au:00044.7.3 | Senders | Orders, Results, Referrals | XCN <name type code (ID)> component must be valued and valid from HL7 Table 200. | |
HL7au:00044.7.4 | Senders | Orders, Results, Referrals | XCN <identifier type code (ID)> component must be valued with a valid value from HL7 Table 203. | |
HL7au:00044.7.5 | Senders | Orders, Results, Referrals | XCN <family name (FN)> :<surname (ST)> sub-component must to be valued. | |
HL7au:00044.7.6 | Senders | Orders, Results, Referrals | XCN <given name (ST)> should be valued. | |
(HL7au:00044.8) | TS datatype conformance points | |||
HL7au:00044.8.1 | Senders | Orders, Results, Referrals | Correct timezone must be specified | |
(HL7au:00044.10) | ED datatype conformance points | |||
(HL7au:00044.10.1) | ED datatype - Senders | |||
HL7au:00044.10.1.1 | Senders | Results, Referrals | ED <type of data (ID)> must be valued. | |
HL7au:00044.10.1.2 | Senders | Results, Referrals | ED <data subtype (ID)> must be valued. | |
HL7au:00044.10.1.3 | Senders | Results, Referrals | ED <encoding (ID)> must be valued. | |
HL7au:00044.10.1.4 | Senders | Results, Referrals | ED <data (ST)> must be valued. | |
HL7au:00044.10.1.5 | Senders | Results, Referrals | When the ED <subtype (ID)> component is valued with a MIME sub-type value, then the corresponding MIME type must be used in the <Type of data (ID)> component. | |
HL7au:00044.10.1.6 | Senders | Results, Referrals | When the ED <subtype (ID)> component is valued with a HL7 2.4 defined <Subtype (ID)> (Table 0291) value, then the corresponding HL7 2.4 type of data (Table 0191) must be used in the <Type of data (ID)> component. | |
(HL7au:00044.10.2) | ED datatype - Receivers | |||
HL7au:00044.10.2.1 | Receivers | Results, Referrals | Receivers must process <type of data (ID)> component case insensitively. | |
HL7au:00044.10.2.2 | Receivers | Results, Referrals | Receivers must process <data subtype (ID)> case insensitively. | |
HL7au:00044.10.2.3 | Receivers | Results, Referrals | Receivers must process the <encoding (ID)> component case insensitively. | |
(HL7au:00044.11) | RP datatype conformance points | |||
(HL7au:00044.11.1) | RP datatype (senders) | |||
HL7au:00044.11.1.1 | Senders | Results, Referrals | RP <pointer (ST) > component must be valued | |
HL7au:00044.11.1.2 | Senders | Results, Referrals | RP <application ID (HD)> component must be valued | |
HL7au:00044.11.1.3 | Senders | Results, Referrals | RP <type of data (ID)> component must be valued | |
HL7au:00044.11.1.4 | Senders | Results, Referrals | RP <subtype (ID)> component must be valued | |
HL7au:00044.11.1.5 | Senders | Results, Referrals | When the RP <subtype (ID)> component is valued with a MIME sub-type value, then the corresponding MIME type must be used in the <Type of data (ID)> component. | |
HL7au:00044.11.1.6 | Senders | Results, Referrals | When the RP <subtype (ID)> component is valued with a HL7 2.4 defined <Subtype (ID)> (Table 0291) value, then the corresponding HL7 2.4 type of data (Table 0191) must be used in the <Type of data (ID)> component. | |
HL7au:00044.11.1.7 (r2) | Receivers | Results, Orders, Referrals | Receivers must understand that a LOINC code of 60572-5 (Report Template ID) signifies the identifier of the report template used to structure the data and not render as patient data. | See 4.6 Specific LOINC codes |
(HL7au:00044.11.1.5) | Encoding URLs into RP datatype | |||
HL7au:00044.11.1.5.1 | Senders | Results, Referrals | When "URI" is specified in RP <application ID (HD)> component - <universal id type (ID)> sub-component value: the URL must be specified by the concatenation of the RP <application ID (HD)> component, <universal id (ST)> sub-component followed by the RP <pointer (ST)>. | |
HL7au:00044.11.1.5.2 | Senders | Results, Referrals | When "URI" is specified in RP <application ID (HD)> component - <universal id type (ID)> sub-component value: the RP <application ID (HD)> component-<namespace id (IS)> sub-component must not be valued. | |
HL7au:00044.11.1.5.3 | Senders | Results, Referrals | When "URI" is specified in RP <application ID (HD)> component - <universal id type (ID)> sub-component value: the RP <application ID (HD)> component, <universal id (ST)> sub-component must be the scheme | server and application path parts of the URL. | |
(HL7au:00045) | Message Acknowledgement | |||
HL7au:00045.1 | Receivers | Orders | Receivers of a valid ORM Order messages must produce an application level acknowledgement - order response message ORR and transmit it back to the original sender, when specified by MSH-16. | |
HL7au:00045.2 | Receivers | Results | Receivers of valid ORU result messages must produce an application level acknowledgement - ACK^R01 and transmit it back to the original sender, when specified by MSH-16. | |
HL7au:00045.3 | Receivers | Orders, Results, Referrals | Receiving systems unable to process a HL7 message must produce the appropriate reject or error application level application level acknowledgement and transmit it back to the sender, provided that the message has a valid MSH and Sending Facility and MSH Control ID field. | |
HL7au:00045.4 (r2) | Receivers | Referrals | Receivers of valid (parsable) REF^I12 result messages must produce an application level acknowledgement - RRI^I12 and transmit it back to the original sender. | |
HL7au:00045.5 | Senders | Referrals | Senders of REF^I12 messages must have the capacity to receive and process RRI^I12 referral response (acknowledgement) messages and indicate success to the sender of the message, and report failures indicated in the response. | |
HL7au:00045.6 | Senders | Referrals | Senders of REF^I12 messages must publish in their secure messaging directory their capability to receive RRI^I12 acknowledgement messages. | |
HL7au:00045.7 (r2) | Senders | Referrals | Secure messaging agents must ensure that there is a valid referral response entry in their provider directory before proceeding to transmit the message. If not, the sending SMD agent must produce an error acknowledgement and return it to the sending application. When using Australian Profile for Provider Directory Services, the sending SMD agent must ensure that it has registered endpoints containing au-receivingfacility that match the outbound message's MSH-4 and au-receivingapplication match MSH-3. | |
HL7au:00045.8 | Receivers | Orders, Results, Referrals, Acknowledgement, Referral Response | Receivers must copy exactly all components of the received message's MSH-3 Sending Application field into the MSH-5 Receiving Application field of the acknowledgement / response message that they produce. | |
HL7au:00045.9 | Receivers | Orders, Results, Referrals, Acknowledgement, Referral Response | Receivers must copy exactly all components of the received message's MSH-4 Sending Facility field into the MSH-6 Receiving Facility field of the acknowledgement / response message that they produce. | |
(HL7au:00046) | General HL7 | |||
(HL7au:00046.1) | Sender Escaping Rules | |||
HL7au:00046.1.1 | Senders | Orders, Results, Referrals | Senders must escape | characters as '\F\' in all fields, components, subcomponents | |
HL7au:00046.1.2 | Senders | Orders, Results, Referrals | Senders must escape '^' characters as '\S\' in all HL7 fields, components and subcomponents | |
HL7au:00046.1.3 | Senders | Orders, Results, Referrals | Senders must escape '&' characters as '\T\' in all HL7 fields, components and subcomponents | |
HL7au:00046.1.4 | Senders | Orders, Results, Referrals | Senders must escape '~' characters as '\R\' in all HL7 fields, components and subcomponents | |
HL7au:00046.1.5 (r2) | Senders | Orders, Results, Referrals | Senders must escape '\' characters as '\E\' in all HL7 fields, components and subcomponents | ** errata - Previous versions incorrectly stated the wrong sequence to use. |
(HL7au:00046.2) | Receiver Escaping Rules | |||
HL7au:00046.2.1 | Receivers | Orders, Results, Referrals | Receivers must unescape '\F\' escape sequences to character '|' for all fields, components, subcomponents | |
HL7au:00046.2.2 | Receivers | Orders, Results, Referrals | Receivers must unescape '\S\' escape sequences to character '^' for all fields, components, subcomponents | |
HL7au:00046.2.3 | Receivers | Orders, Results, Referrals | Receivers must unescape '\T\' escape sequences to character '&' for all fields, components, subcomponents | |
HL7au:00046.2.4 | Receivers | Orders, Results, Referrals | Receivers must unescape '\R\' escape sequences to character '~' for all fields, components, subcomponents | |
HL7au:00046.2.5 | Receivers | Orders, Results, Referrals | Receivers must unescape '\E\' escape sequences to character '\' for all fields, components, subcomponents | |
HL7au:00046.3 | Senders | Orders, Results, Referrals | All fields required by HL7 segments table must be validly valued. | |
HL7au:00046.4 (r2) | Receivers | Orders, Results, Referrals | Receiving implementations when receiving HL7 messages and converting their contents to data values must ignore fields, components, sub-components, and extra repetitions of a field that are present but were not expected. | *Varied from HL7 2.4 2.11 |
HL7au:00046.5 (r2) | Receivers | Orders, Results, Referrals | Receiving implementations when receiving HL7 messages and converting their contents to data values must treat segments that were expected but are not present as an error. | *Varied from HL7 2.4 2.11 |
HL7au:00046.6 | Receivers | Orders, Results, Referrals | Receiving implementations when receiving HL7 messages and converting their contents to data values must treat fields and components that are expected but were not included in a segment as not present. | HL7 2.4 2.11 |
HL7au:00047.1 | Senders | Orders, Results, Referrals | MSH-15 Accept acknowledgement type (ID) must be valued AL | |
HL7au:00047.2 | Senders | Orders, Results, Referrals | MSH-16 Application acknowledgement type (ID) must be valued AL | |
HL7au:00048.1 | Senders | Orders, Results, Referrals | When MSH-18 is unvalued or valued as "ASCII" the message must contain only characters in the range ASCII 32 to ASCII 127 and cursor return ASCII 13 which must only be used as segment separator. | |
HL7au:00048.2 | Senders | Orders, Results, Referrals | When MSH-18 is valued and is not "ASCII" encoding the message must not contain characters less than ASCII 32, except for ASCII 13 which must only be used as segment separator. | |
HL7au:00048.3.1 (r3) | Senders | Orders, Results, Referrals | MSH-18 must only contain one of the following values "", "ASCII" or by site agreement "UNICODE UTF-8", "8859/1" may be used. | It is hoped to allow "UNICODE UTF-8" in a future version, but this depends on widespread receiver support. Receivers are encouraged to develop capability for UTF-8. ** errata "UNICODE UTF-8" was incorrectly added as "UTF-8" |
HL7au:00048.3.2 (r1) | Deleted. Merged into HL7au:00048.3.1 (r3) | |||
HL7au:00048.3.3 | Senders | Orders, Results, Referrals | The encoding of characters in the message must match the value specified in MSH-18 | |
HL7au:00048.4 | Senders | Orders, Results | When "UNICODE" is specified in MSH-18 a byte order mark (BOM) must be present at the start of the transmission. | Refer to 2.1.9.18 MSH-18 Character set (ID) 00692. Note that UNICODE is deprecated. |
HL7au:00049.1 | Senders | Orders, Results, Referrals | MSH-9 Message type <message type (ID)> component must be valued. | |
HL7au:00049.2 | Senders | Orders, Results, Referrals | MSH-9 Message type <trigger event (ID)> component must be valued. | |
HL7au:00049.3 | Senders | Orders, Results, Referrals | MSH-9 Message type <message structure (ID)> component must be valued. | |
HL7au:00050.1 | Pathology Sending | |||
HL7au:00050.1.2 | Senders (Pathology only) | Results | When sending pathology messages OBX-3 must be valued according to the APUTS standard where a code is available. | |
HL7au:00050.1.3 | Senders (Pathology only) | Results | The OBX-6 (Units) <text (ST)> component of the primary identifier must be valued according to APUTS preferred unit for the term. | |
HL7au:00050.1.4 | Senders (Pathology only) | Results | The OBX-6 (Units) <identifier (ST)> component of the primary must be the case sensitive UCUM code. | |
HL7au:00050.1.5 | Senders (Pathology only) | Results | The OBX-6 (Units) <name of coding system (IS)> component must be "UCUM". | |
HL7au:00050.1.6 | Senders (Pathology only) | Results | The OBX-7 References range (ST) should be valued as the APUTS harmonised reference intervals where defined and applicable. | |
HL7au:00050.1.7 | Senders (Pathology only) | Results | Display segments must be produced according to the APUTS Chapter 7 rendering rules. | |
HL7au:00050.2.1 | Receivers | Results | Where a receiving system renders an atomic pathology result it must comply with the rendering APUTS Chapter 7 rendering rules. | |
HL7au:00050.2.2 | Receivers | Results | When rendering a cumulative table or graph of pathology data, do not combine series which have different LOINC codes or have the "Do not combine" flag indicated in any repeat of OBX-17 which is indicated by "765921000168105^Do not combine laboratory test result^SCT". | See 4.13 |
HL7au:00060.1 | Senders | Orders, Results, Referrals | HL7 message elements with a usage of R (required) must be valued. | |
HL7au:00060.2 | Senders | Orders, Results, Referrals | HL7 message elements with a usage of RE (required or empty) must be valued, except if the data is unknown to the sending application. | |
HL7au:00060.3 | Senders | Orders, Results, Referrals | HL7 message elements with a usage of C (conditional) must be valued when the associated predicate is satisfied. | From HL7 Conformance Implementation Manual. |
HL7au:00060.4 | Senders | Orders, Results, Referrals | HL7 message elements with a usage of C (conditional) must not be valued when the associated predicate is not satisfied. | From HL7 Conformance Implementation Manual. |
HL7au:00060.5 | Senders | Orders, Results, Referrals | HL7 message elements with a usage of CE (condition or empty) must be valued when known to the application, and must be unvalued when the application does not know the value. | |
HL7au:00060.6 | Senders | Orders, Results, Referrals | Sending application must be capable of knowing which conditional elements to populate when conditional rules (predicate) are satisfied for conditional or empty elements. | Adapted from HL7 Conformance Implementation Manual. |
HL7au:00060.7 | Senders | Orders, Results, Referrals | HL7 message elements with a usage of CE (condition or empty) must not be valued when the associated predicate (conditional rule) is not satisfied. | Adapted from HL7 Conformance Implementation Manual. |
HL7au:00061.1 | Receivers | Orders, Results, Referrals | If a HL7 message element with a usage of CE is not present, the receiving application shall not raise an error due to the presence or absence of the element. | |
HL7au:00100.1 (r2) | Senders | Referrals | The current referral summary OBR/OBX group must appear as the first OBR/OBX group in the message. | |
HL7au:00100.2 | Receivers | Referrals(L2) | The receiver when displaying the inbound referral, must primarily show the content of a referral letter display segment belonging the Clinical Information for the referral OBR/OBX group indicated by the OBR-4 code as per section 4.4.1.4.1 OBR-4 codes in referral messages. | |
HL7au:00100.3 (r3) | Receivers | Referrals(L2) | The receiver must also show clearly that there is supporting information for the referral and allow the user to view those, each must have a either a PDF/HTML/TXT/RTF display segment. | |
HL7au:00101.1 (r2) | Senders | Results, Referrals(L2) | Each OBR/OBX group may contain arbitrary encapsulated data attachments as per 4.26 Non-Displayable Supporting data. | |
HL7au:00101.2 | Senders | Results, Referrals(L2) | Encapsulated data attachments must use Base64 encoding. | |
HL7au:00101.3 | Senders | Results, Referrals(L2) | Senders must not send critical data in encapsulated data attachments, since it may be unreliable in that the MIME type may be unsupported by the receiver and content unviewable. | |
HL7au:00101.4 (r2) | Receivers | Results, Referrals(L2) | While displaying the content for each OBR/OBX group any encapsulated data attachments as described in 4.26 Non-Displayable Supporting data must be listed to the user. | |
HL7au:00101.5 | Receivers | Results, Referrals(L2) | Encapsulated data attachments listed to the user in the previous point must be accessible to the user if a suitable viewer for the MIME type and MIME subtype is available on the system. | |
HL7au:00101.6 | Receivers | Results, Referrals(L2) | Receivers must support viewing attachments with MIME type/subtype of application/pdf and text/html. | |
HL7au:00101.7 | Receivers | Results, Referrals(L2) | Receivers may support encapsulated data attachments MIME type/subtype such as OpenXML Documents: application vnd.openxmlformats-officedocument.spreadsheetml.sheet | |
HL7au:00101.8 | Receivers | Results, Referrals(L2) | Receiver systems must restrict access to attachments of trusted MIME types (the trusted MIME types may be configurable according to an organisation policy). | |
HL7au:00102.1.2 (r2) | Senders | Referrals | For the "Referral Summary" OBR/OBX group (indicated by the OBR-4 code as per section 4.4.1.4.1 OBR-4 codes in referral messages) in the referral message, the Report template ID OBX must be included when atomic data is to be provided and it must specify the unique root sub id in OBX-4 subID. e.g. sub id "1" | |
HL7au:00102.2.1 (r2) | Senders | Referrals | For the "Referral Summary" OBR/OBX group (indicated by the OBR-4 code as per section 4.4.1.4.1 OBR-4 codes in referral messages) in the referral message, atomic data must be sent in OBXs with their appropriate OBX-2 value as specified the method specified in Appendix 9 HL7v2 Virtual Medical Record (Normative) | |
HL7au:00102.2.2 (r2) | Senders | Referrals | For the "Referral Summary" OBR/OBX group (indicated by the OBR-4 code as per section 4.4.1.4.1 OBR-4 codes in referral messages) in the referral message, atomic data must be sent in OBXs with their appropriate OBX-3 value as specified the method specified in Appendix 9 HL7v2 Virtual Medical Record (Normative) | |
HL7au:00102.2.3 (r2) | Senders | Referrals | For the "Referral Summary" OBR/OBX group (indicated by the OBR-4 code as per section 4.4.1.4.1 OBR-4 codes in referral messages) in the referral message, atomic data must be sent in OBXs with their appropriate OBX-4 subID value relative to the subID specified in the Report template ID OBX as specified the method specified in Appendix 9 HL7v2 Virtual Medical Record (Normative) | |
HL7au:00103.3 (r2) | Senders | Referrals | For the current "Referral Summary" OBR/OBX group (indicated by the OBR-4 code as per section 4.4.1.4.1 OBR-4 codes in referral messages) in the referral message, the display segment must reflect content from taht OBR/OBX group as well as the Allergies, and Medication segments of the REF message. | |
HL7au:00104.1.1 | Senders | Referrals | There must be exactly one PRD with a PRD-1 value of "AP" (Authoring Provider) in the REF message. | |
HL7au:00104.1.1 | Receivers | Referrals | The receiving system must identify the authoring provider in its display of the message content (indicated by "AP" in the associated PRD-1). | |
HL7au:00104.2.1 | Senders | Referrals | There must be exactly one PRD with a PRD-1 value of "IR" (Intended Recipient) in the REF message. | |
HL7au:00104.2.2 | Receivers | Referrals | The receiving system must present the referral message to intended recipient indicated by PRD-1 value of "IR". | |
HL7au:00104.7.0 (r3) | Senders | Referrals | PRD-7 must have at least 1 repeat (for providers receiving electronic communication specified by IR - Intended Recipient in PRD-1). | |
HL7au:00104.7.1.2 | Senders | Referrals | PRD-7 <ID number (ST)> must be valued with a location or organisationally scoped identifier (for providers receiving electronic communication). | |
HL7au:00104.7.1.3 (r2) | Senders | Referrals | PRD-7 <ID number (ST)> must not contain an HPI-I value (for providers receiving electronic communication). | HPI-I values must be qualified by the HPI-O. See NPIO in HL7 Table 0203 - Identifier Type. |
HL7au:00104.7.1.4 | Senders | Referrals | For a PRD-7 <ID number (ST)> the correct matching <type of ID number (IS)> and <other qualifying info (ST)> must be used as per table Table 7.3.3.7.1 - Valid PRD-7 component matches | |
HL7au:00104.7.2.1 | Senders | Referrals | PRD-7 <type of ID number (IS)> must be valued from User-defined Table 0363 - Assigning Authority. | |
HL7au:00104.7.3.1 | Senders | Referrals | <other qualifying info (ST)> must be a valued from HL7 Table 0203 - Identifier Type. | |
HL7au:00110.1 | Senders | Orders, Results, Referrals, Acknowledgment, Referral Response | Senders must populate the MSH-3 Sending application (HD) field components as per the values specified in the provider directory of their secure messaging system being used. | The intent of this point is to enable a receiver the ability to lookup the sender in the directory, which will allow return messaging. This also applies to senders of acknowledgements. |
HL7au:00110.2 | Senders | Orders, Results, Referrals, Acknowledgment, Referral Response | Senders must populate the MSH-4 Sending facility (HD) field components as per the values specified in the provider directory of their secure messaging system being used. | The intent of this point is to enable a receiver the ability to lookup the sender in the directory, which will allow return messaging. This also applies to senders of acknowledgements. |
** note that regular browsers do not support this feature directly, xhtml preprocessing is required before display with browser |
clarify scope of uniqueness (within scope of MSH-4)