HS.FHIR.Validation.ResourceValidator

deprecated class HS.FHIR.Validation.ResourceValidator extends %Library.RegisteredObject

THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.

Method Inventory

Methods

deprecated classmethod ValidateBySchematron(pContentType As %String = "", pResourceStreamOrString="", pResourceObject="", pResourceSchema As %String, pResourceType As %String, pTransformer, pXSLTDir As %String, ByRef pErrors As HS.Types.FHIR.Errors) as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
ValidateBySchematron validates a given FHIR resource stream, string, %XML.Document object or %DynamicObject against its schematron rules. If both a stream/string and an object are passed in, the object is used. Streams/strings and objects that are passed in are not updated by this method. If an object is not passed in, one is formulated from the stream/string, and the object is available for the caller to receive back and re-use for other purposes if desired. If validation errors are incurred, the return status is set to a fail status and the validation errors are returned in an HS.Types.FHIR.Errors object.
Inputs:
  • pContentType : (required if pResourceObject not provided) May be the ContentType from a FHIR request, or even just "json" or "xml".
  • pResourceStreamOrString : (required if pResourceObject not provided) FHIR XML resource stream object or string.
  • pResourceSchema : Class package to use as the schema. Example is "HS.FHIR.vSTU3.Model.Resource".
  • pResourceObject : (required if pResourceStreamOrString not provided) %XML.Document object or %DynamicObject representation of the FHIR resource.
  • pTransformer : XSLT2 transformer object. If one is not passed in, then one is created by this method, however, that will incur a performance cost.
  • pXSLTDir : /csp/xslt sub-directory path for the location of the schematron XSLT2 stylesheet files to use.
    Outputs:
  • pResourceObject : %XML.Document object or %DynamicObject representation of the FHIR resource.
  • pErrors : HS.Types.FHIR.Errors object that includes a collection of error information.
  • deprecated classmethod ValidateBySchematronXMLStream(pResourceType As %String, pXMLStream, pTransformer, pXSLTDir As %String, ByRef pErrors As HS.Types.FHIR.Errors) as %Status
    THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
    ValidateBySchematronXMLStream validates a given FHIR resource XML stream against the schematron rules provided by the HL7 FHIR specification. If validation errors are incurred, the return status is set to a failure status and the validation errors are returned in an HS.Types.FHIR.Errors object.
    Inputs:
  • pResourceType : (required) FHIR resource type.
  • pXMLStream : (required) FHIR XML stream object.
  • pTransformer : (required) Transformer object to use for the XSLT2 schematron evaluation.
  • pXSLTDir : (required) XSLT directory that holds the XSLTs that will execute the schematron validation. Example is "FHIR/vDSTU2/Schematron".
    Output:
  • pErrors : HS.Types.FHIR.Errors object that includes a collection of error information. See HS.Types.FHIR.Errors for more details.
  • deprecated classmethod ValidateDynamicObj(pJSONDynamicObject As %Library.DynamicObject, pResourceSchema As %String, ByRef pErrors As HS.Types.FHIR.Errors) as %Status
    THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
    ValidateDynamicObj validates a given FHIR resource %DynamicObject against a specified schema. If validation errors are incurred, the return status is set to a failure status and the validation errors are returned in an HS.Types.FHIR.Errors object.
    Inputs:
  • pJSONDynamicObject : (required) FHIR resource %DynamicObject.
  • pResourceSchema : (required) Class package to use as the schema. Example is "HS.FHIR.vSTU3.Model.Resource".
    Output:
  • pErrors : HS.Types.FHIR.Errors object that includes a collection of error information. See HS.Types.FHIR.Errors for more details.
  • deprecated classmethod ValidateResource(pContentType As %String = "", pResourceStreamOrString="", pResourceSchema As %String, ByRef pResourceObject="", ByRef pErrors As HS.Types.FHIR.Errors) as %Status
    THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
    ValidateResource validates a given FHIR resource stream, string, %XML.Document object or %DynamicObject against a specified schema. If both a stream/string and an object are passed in, the object is used. Streams/strings and objects that are passed in are not updated by this method. If an object is not passed in, one is formulated from the stream/string, and the object is available for the caller to receive back and re-use for other purposes if desired. If validation errors are incurred, the return status is set to a fail status and the validation errors are returned in an HS.Types.FHIR.Errors object.
    Inputs:
  • pContentType : (required if pResourceObject not provided) May be the ContentType from a FHIR request, or even just "json" or "xml".
  • pResourceStreamOrString : (required if pResourceObject not provided) FHIR XML resource stream object or string.
  • pResourceSchema : Class package to use as the schema. Example is "HS.FHIR.vSTU3.Model.Resource".
  • pResourceObject : (required if pResourceStreamOrString not provided) %XML.Document object, %XML.Node object, or %DynamicObject representation of the FHIR resource.
    Outputs:
  • pResourceObject : %XML.Document object or %DynamicObject representation of the FHIR resource.
  • pErrors : HS.Types.FHIR.Errors object that includes a collection of error information.
  • deprecated classmethod ValidateXMLDocument(pXMLDocument, pResourceSchema As %String, ByRef pErrors As HS.Types.FHIR.Errors) as %Status
    THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
    ValidateXMLDocument validates a given FHIR resource %XML.Document or %XML.Node object against a specified schema. If validation errors are incurred, the return status is set to a failure status and the validation errors are returned in an HS.Types.FHIR.Errors object.
    This method allows for taking a %XML.Node object as input to allow the caller to locate a resource within a resource (%XML.Node within an %XML.Document) and use that inner resource as the input to the validation.
    Inputs:
  • pXMLDocument : (required) FHIR resource %XML.Document or %XML.Node object.
  • pResourceSchema : (required) Class package to use as the schema. Example is "HS.FHIR.vSTU3.Model.Resource".
    Output:
  • pErrors : HS.Types.FHIR.Errors object that includes a collection of error information. See HS.Types.FHIR.Errors for more details.
  • Inherited Members

    Inherited Methods

    Feedback