IHE FormatCode Vocabulary
1.0.0 - normative

This page is part of the IHE FormatCode Vocabulary (v1.0.0: Release) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Background

The code specifying the detailed technical format of the document. Along with the mimeType, it should provide sufficient information to allow potential consumer to know if it will be able to process the document.

The mimeType indicates the base format; the formatCode indicates the detailed-level technical structure and profiled constraints. Together with the mimeType, the formatCode used shall be sufficiently specific to ensure processing/display by identifying a document encoding, structure and template (e.g., for a CDA Document, the fact that it complies with a CDA schema, possibly a template and the choice of a content-specific style sheet).

The formatCode is often an indicator of the IHE Document Content Profile to which the document conforms.

The mimeTypeSufficient formatCode of EV("urn:ihe:iti:xds:2017:mimeTypeSufficient", "1.3.6.1.4.1.19376.1.2.3") may be used when the mimeType is sufficient to identify the technical format of the document, or where there are no constaints imposed on the content by a profile. Format codes may be specified by multiple organizations. Format codes for Document Content Profiles defined by the ITI domain shall be in URN format and have names with the prefix

urn:ihe:iti:

Format codes defined by other IHE domains shall have names with the prefix

urn:ihe:’domain initials’:

The IHE-managed codes and value set for formatCode are previously published on http://wiki.ihe.net/index.php/IHE_Format_Codes. Format codes defined by non-IHE domains should be a valid unique URN.

As of December 2019, IHE and HL7 have worked together to transition the HL7 defined codes for C-CDA into the HL7 codesystem management. Thus these codes are now indicated as deprecated in the IHE CodeSystem, as they now exist in HL7 CodeSystem http://terminology.hl7.org/CodeSystem/hl7-document-format-codes

IHE co-chairs must follow the instructions for submitting change to the IHE FormatCode vocabulary as documented on the IHE GitHub repository for this FormatCode implementation guide.