Federico Calò's FSE Document Validator - Clinical Decision Support Architecture (CDA) Level 3 and Gateway Initialization File.

Validate CDA Level 3 documents for the Italian Electronic Health Record Folder 2.0: check mandatory HL7 tags, namespace, AGID templateId and national OID. Simulate Gateway INI scenarios (publishDocument, searchDocument, getDocument) with mock JSON responses - all client-side processing - no clinical data transmitted to external servers.

Work on healthcare systems or FSE integrations?

Subscribe to the monthly newsletter of Federico for insights on health care interopertability, HL7 / FHIR standards and back-end development in a healthcare context.

Come utilizzare FSE Document Validator

Attach the CDA L3 document to the "Validate CDA XML" sheet.

Attach your XML CDA Level 3, or load the ready-to-use sample document to see how the validator works on a laboratory report that conforms.

Start validation and read the report

Validator checks HL7 v3 namespace, ClinicalDocument root element, required tags (typeId, templateId, id, code, effectiveTime, recordTarget, author, custodian, component), structuredBody structure and national OIDs, returning errors, warnings, and information.

Pass to the "Gateway INI" sheet to simulate integration

Select one of the 8 mock scenarios (publishDocument, searchDocument, getDocument with success/error results) by entering patientId, documentId or search query to test how your integration should handle each gateway response.

Analyze simulated JSON response

Observe HTTP status, JSON payload and error codes from each scenario to verify error handling in your client before integrating with the real environment.

Suggerimenti

  • Start from the example document included in the tool: it's a CDA lab report L3 minimum and compliant, useful as a starting point to modify for your tests.
  • Be aware of warnings (not just errors): an invalid OID or malformed effectiveTime can prevent the document from being saved, but may cause compatibility issues with other regional FSE systems.
  • Use the Gateway INI simulator to verify that your client correctly handles all error scenarios (409 duplicate, 403 unauthorized, 404 not found), not just successful paths.

Domande frequenti

What exactly does the CDA L3 validator check?

Check the HL7 v3 namespace, ClinicalDocument root element, mandatory CDA R2 standard tags (typeId, templateId, id, code, effectiveTime, recordTarget, author, custodian, component), OID document and patient format, effectiveTime format, and presence of structuredBody, indicating level 3 CDA.

Are clinical documents that are linked sent to a server?

No, validation occurs entirely on the client side via browser's DOMParser; no clinical data or attached XML is sent to external servers: you can verify this by testing the tool offline after initial page load.

What are "template IDs" and how are they recognized?

Template ID is an OID (e.g. 2.16.840.1.113883.2.9.10.1.1) that identifies the specific type of FSE document, such as lab report, dismissal letter, synthetic health profile or prescription medication. The validator automatically recognizes 10 common document types by comparing the found Template IDs with the national OID catalog AGID.

Does the Gateway simulator return real data from the national healthcare system?

No, responses are mock generated entirely in the browser, designed to mimic JSON structure and XDS/IHE error codes (e.g. XDSDocumentUniqueIdError, XDSUnknownDocumentEntry) typical of the INI interoperability profile, useful for testing your client's error handling before real integration.

Is a document without errors guaranteed to be conformant and accepted by the real INI Gateway?

No. The validator covers the main structural checks of CDA R2 standard and FSE 2.0 specifications, but does not replace official validation against XSD schemas and AGID/Ministry of Health compliance profiles required for real accreditation to the FSE system.