This wiki has undergone a migration to Confluence found Here
<meta name="googlebot" content="noindex">

Difference between revisions of "Conformance validation"

From HL7Wiki
Jump to navigation Jump to search
 
Line 1: Line 1:
 
Return to [[Structured Documents Internal Working Documents]] page. Return to [[Structured Documents TC|SDTC]] page.
 
Return to [[Structured Documents Internal Working Documents]] page. Return to [[Structured Documents TC|SDTC]] page.
  
−
Objective: Clarify what these terms mean from a (schematron) validation perspective: Cardinality, Required, Mandatory, SHALL, Required if Known
+
SHALL/SHOULD/MAY vs. R/R2 vs. Required/Mandatory [see: http://www.hl7.org/v3ballot/html/help/pfg/pfg.html#shall_should_usage]
  
−
'''Cardinality''': The cardinality expresses the number of times an attribute or association may appear in a derived model or message. (Source: HL7 V3 "Refinement, Constraint and Localization" chapter).
+
'''SHALL''': Corresponds to HMD "Required" if on XML element (i.e. the element is there, but can be NULL); Corresponds to HMD "Mandatory" if on XML attribute. Corresponds to IHE "R".
  
−
'''Required''': this is an HL7 term, that is probably close to IHE's "Required if Known". This does not imply a lower cardinality of 1. There's no way to validate this, because the field need not be sent if the value isn't known. (Source: HL7 V3 "Refinement, Constraint and Localization" chapter).
+
'''SHOULD''': Corresponds to IHE "R2".
  
−
'''Mandatory''': this is an HL7 term, which implies a lower cardinality of 1, and disallows NULL values. (Source: HL7 V3 "Refinement, Constraint and Localization" chapter).
+
Where necessary to explicitly preclude NULL (e.g. where you want to preclude NULL on observation/value), can include something like "SHALL NOT include nullFlavor".
−
 
 
−
'''SHALL''' (e.g. Document SHALL contain exactly one clinicalDocument/id): SHALL implies a lower cardinality of 1. SHALL doesn't disallow NULL values. If NULL values are to be excluded, this would have to be done by additional explicit conformance statement. (Source: RFC 2119, http://www.ietf.org/rfc/rfc2119.txt).
 
−
 
 
−
'''Required if Known''' (e.g. clinicalDocument/id is Required if Known): Similar to Required (and can't be schematron-validated). (Equals RFC 2119 'RECOMMENDED')
 

Latest revision as of 04:05, 10 January 2011

Return to Structured Documents Internal Working Documents page. Return to SDTC page.

SHALL/SHOULD/MAY vs. R/R2 vs. Required/Mandatory [see: http://www.hl7.org/v3ballot/html/help/pfg/pfg.html#shall_should_usage]

SHALL: Corresponds to HMD "Required" if on XML element (i.e. the element is there, but can be NULL); Corresponds to HMD "Mandatory" if on XML attribute. Corresponds to IHE "R".

SHOULD: Corresponds to IHE "R2".

Where necessary to explicitly preclude NULL (e.g. where you want to preclude NULL on observation/value), can include something like "SHALL NOT include nullFlavor".

Retrieved from "https://wiki.hl7.org/w/index.php?title=Conformance_validation&oldid=45194"