Difference between revisions of "IHE Format Codes"

From IHE Wiki
Jump to navigation Jump to search
(→‎IHE defined Format Codes: added a note regarding the PCC IPS format code template id)
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
The tables below lists the Document Sharing [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_2_9_DocumentEntry_formatC format codes (FormatCode)], template identifiers, and media types used by the Document Sharing "Document Content" Profiles.
+
The IHE FormatCode vocabulary is now managed in an Implementation Guide published using FHIR.
 +
* formal canonical URI [http://profiles.ihe.net/fhir/ihe.formatcode.fhir/index.html http://ihe.net/fhir/ihe.formatcode.fhir/CodeSystem/formatcode]
 +
* formal publication URL http://profiles.ihe.net/fhir/ihe.formatcode.fhir/index.html
 +
* [https://github.com/IHE/FormatCode FormatCode gitHub repository] for source of the Implementation Guide can be used to register issues, or create pull requests for modifications. Formal governance is managed by ITI Technical Committee.
  
This page represents:  
+
This FormatCode vocabulary represents:  
 
* Code System '''1.3.6.1.4.1.19376.1.2.3'''
 
* Code System '''1.3.6.1.4.1.19376.1.2.3'''
 
* Value Set  '''1.3.6.1.4.1.19376.1.2.7.1'''
 
* Value Set  '''1.3.6.1.4.1.19376.1.2.7.1'''
 
__TOC__
 
<br/>
 
=IHE defined Format Codes=
 
Note that the code system for these codes is '''1.3.6.1.4.1.19376.1.2.3''' as assigned by the ITI Domain for codes used for the purposes of cross-enterprise document sharing (XDS). For more information see [[ITI - OID assignment 1.3.6.1.4.1.19376.1.2]].
 
 
These codes are part of the IHE FormatCodes ValueSet identified by 1.3.6.1.4.1.19376.1.2.7.1.
 
<br/>
 
Note these codes have been pulled into a FHIR value set -- http://hl7.org/fhir/ValueSet/formatcodes
 
<br/>
 
These codes have been published by IHE on the IHE FTP - FHIR directory as a FHIR CodeSystem and FHIR ValueSet. See [[Implementation Material]]
 
<br/>
 
{{T|Profile|Format Code|Media Type|Template ID|Title=XDS Metadata by Profile|
 
Rows=
 
{{RH|4|PCC Profiles}}
 
{{R|Medical Summaries (XDS-MS)|urn:ihe:pcc:xds-ms:2007|text/xml|1.3.6.1.4.1.19376.1.5.3.1.1.3 (Referral)<br/>1.3.6.1.4.1.19376.1.5.3.1.1.4 (Discharge Summary)}}
 
{{R|Exchange of Personal Health Records (XPHR) | urn:ihe:pcc:xphr:2007 | text/xml | 1.3.6.1.4.1.19376.1.5.3.1.1.5 (Extract)<br/>1.3.6.1.4.1.19376.1.5.3.1.1.6 (Update)}}
 
{{R|Emergency Department Referral (EDR)| urn:ihe:pcc:edr:2007 | text/xml |  1.3.6.1.4.1.19376.1.5.3.1.1.10}}
 
{{R|Antepartum Summary (APS)| urn:ihe:pcc:aps:2007 | text/xml | 1.3.6.1.4.1.19376.1.5.3.1.1.11.2}}
 
{{R|Emergency Department Encounter Summary (EDES)| urn:ihe:pcc:edes:2007 | text/xml | 1.3.6.1.4.1.19376.1.5.3.1.1.13.1.1 (Triage Note)<br/>
 
1.3.6.1.4.1.19376.1.5.3.1.1.13.1.2 (Nursing Note)<br/>
 
1.3.6.1.4.1.19376.1.5.3.1.1.13.1.3 (Composite Triage and Nursing Note)<br/>
 
1.3.6.1.4.1.19376.1.5.3.1.1.13.1.4 (Physician Note)}}
 
{{R|Antepartum Record (APR) - History and Physical | urn:ihe:pcc:apr:handp:2008 | text/xml | 1.3.6.1.4.1.19376.1.5.3.1.1.16.1.1 (Antepartum History and Physical) }}
 
{{R|Antepartum Record (APR) - Laboratory | urn:ihe:pcc:apr:lab:2008 | text/xml | 1.3.6.1.4.1.19376.1.5.3.1.1.16.1.2 (Antepartum Laboratory) }}
 
{{R|Antepartum Record (APR) - Education | urn:ihe:pcc:apr:edu:2008 | text/xml | 1.3.6.1.4.1.19376.1.5.3.1.1.16.1.3 (Antepartum Education) }}
 
{{R|Immunization Content (IC) | urn:ihe:pcc:ic:2008 | text/xml | 1.3.6.1.4.1.19376.1.5.3.1.1.18.1.2 (Immunization Detail) }}
 
{{R|Cancer Registry Content (CRC)| urn:ihe:pcc:crc:2008 | text/xml | &nbsp; }}
 
{{R|Care Management (CM)| urn:ihe:pcc:cm:2008 | text/xml | &nbsp; }}
 
{{R|Routine Interfacility Patient Transport (RIPT) | urn:ihe:pcc:ript:2017 | text/xml | 1.3.6.1.4.1.19376.1.5.3.1.1.28.1 }}
 
{{R|Triage Notes (TN) | urn:ihe:pcc:tn:2007 | text/xml | . }}
 
{{R|Nursing Notes (NN) | urn:ihe:pcc:nn:2007 | text/xml | . }}
 
{{R|??? (???) | urn:ihe:pcc:ctn:2007 | text/xml | . }}
 
{{R|??? (???) | urn:ihe:pcc:edpn:2007 | text/xml | . }}
 
{{R|??? (???) | urn:ihe:pcc:hp:2008 | text/xml | . }}
 
{{R|Labor and Delivery History and Physical (LDHP) | urn:ihe:pcc:ldhp:2009 | text/xml | . }}
 
{{R|Labor and Delivery Summary (LDS) | urn:ihe:pcc:lds:2009 | text/xml | . }}
 
{{R|Maternal Discharge Summary (MDS) | urn:ihe:pcc:mds:2009 | text/xml | . }}
 
{{R|??? (???) | urn:ihe:pcc:nds:2010 | text/xml | . }}
 
{{R|Postpartum Visit Summary (PPVS) | urn:ihe:pcc:ppvs:2010 | text/xml | . }}
 
{{R|??? (???) | urn:ihe:pcc:trs:2011 | text/xml | . }}
 
{{R|Emergency Department Transport Summary (ETS) | urn:ihe:pcc:ets:2011 | text/xml | . }}
 
{{R|Interfacility Transport Summary (ITS) | urn:ihe:pcc:its:2011 | text/xml | . }}
 
{{R|Paramedicine Care Summary – Clinical Subset (PCS-CS) | urn:ihe:pcc:pcs-cs:2018 | text/xml | 1.3.6.1.4.1.19376.1.5.3.1.1.29.1 }}
 
{{R|Paramedicine Care Summary – Complete Report (PCS-CR) | urn:ihe:pcc:pcs-cr:2018 | text/xml | 1.3.6.1.4.1.19376.1.5.3.1.1.30.1 }}
 
{{R|International Patient Summary (IPS) | urn:ihe:pcc:ips:2020 | text/xml | 2.16.840.1.113883.10.22.1.1 Note: The template ID is taken from the HL7 IPS and this document is a version of HL7’s CDA
 
International Patient Summary. This is an HL7 template that builds on the 2018 HL7 IPS and a
 
collaborative document that reflects the updated items that will be harmonized.
 
}}
 
 
{{RH|4|ITI Profiles}}
 
{{R| [[Scanned Documents]] (PDF) | urn:ihe:iti:xds-sd:pdf:2008 | text/xml | 1.3.6.1.4.1.19376.1.2.20 (Scanned Document)}}
 
{{R| [[Scanned Documents]] (text) | urn:ihe:iti:xds-sd:text:2008 | text/xml |  1.3.6.1.4.1.19376.1.2.20 (Scanned Document)}}
 
{{R| [[Basic Patient Privacy Consents]] | urn:ihe:iti:bppc:2007 | text/xml | 1.3.6.1.4.1.19376.1.5.3.1.1.7 (BPPC with ''no'' scanned part)}}
 
{{R| [[Basic Patient Privacy Consents]] with Scanned Document| urn:ihe:iti:bppc-sd:2007  | text/xml| 1.3.6.1.4.1.19376.1.5.3.1.1.7.1 (BPPC ''with'' scanned part) }}
 
{{R| [[XDW]] Workflow Document | urn:ihe:iti:xdw:2011:workflowDoc  | text/xml| N/A  }}
 
{{R| [[DSG]] Detached Document | urn:ihe:iti:dsg:detached:2014  | text/xml| N/A  }}
 
{{R| [[DSG]] Enveloping Document | urn:ihe:iti:dsg:enveloping:2014  | text/xml| N/A  }}
 
{{R| [[Advanced Patient Privacy Consents]] | urn:ihe:iti:appc:2016:consent | text/xml | N/A }}
 
{{R| none | urn:ihe:iti:xds:2017:mimeTypeSufficient | undefined | note: CP-ITI-1060: may be used when mimeType is sufficient }}
 
 
{{RH|4|LAB Profiles}}
 
{{R|CDA Laboratory Report |urn:ihe:lab:xd-lab:2008| text/xml| 1.3.6.1.4.1.19376.1.3.3 (Laboratory Report)}}
 
{{RH|4|Radiology Domain Profiles}}
 
{{R|XDS-I CDA Wrapped Text Report (XDS-I) | urn:ihe:rad:TEXT | text/xml | . }}
 
{{R|XDS-I PDF (XDS-I) | urn:ihe:rad:PDF | application/pdf | Note PDF/A without CDA wrapper. }}
 
{{R|XDS-I Imaging Report with Structured Headings (XDS-I) | urn:ihe:rad:CDA:ImagingReportStructuredHeadings:2013 | text/xml | . }}
 
 
{{RH|4|Cardiology Domain Profiles}}
 
{{R|Cardiology Cath Report Content (CRC) | urn:ihe:card:CRC:2012 | text/xml | 1.3.6.1.4.1.19376.1.4.1.1.2 (Cath Report Content) }}
 
{{R|Cardiology Electrophysiology Implant/Explant Report Content (EPRC-IE) | urn:ihe:card:EPRC-IE:2014 | text/xml | 1.3.6.1.4.1.19376.1.4.1.1.3 (EP Report Content) }}
 
{{R|Cardiac Imaging Report (CIRC) |urn:ihe:card:imaging:2011| text/xml| 1.3.6.1.4.1.19376.1.4.1.1.1 (Cardiac Imaging Report)}}
 
{{R|Cardiac Procedure Note (CPN) |urn:ihe:card:CPN:2017| text/xml| 1.3.6.1.4.1.19376.1.4.1.1.4 (Cardiac Procedure Note)}}
 
 
 
{{RH|4|Dental Domain Profiles}}
 
{{R|Dental CDA Wrapped Text Report (DENT) | urn:ihe:dent:TEXT | text/xml | . }}
 
{{R|Dental PDF (DENT) | urn:ihe:dent:PDF | application/pdf | Note PDF/A without CDA wrapper. }}
 
{{R|Dental Imaging Report with Structured Headings (DENT) | urn:ihe:dent:CDA:ImagingReportStructuredHeadings:2013 | text/xml | . }}
 
 
{{RH|4|QRPH Profiles (See [https://wiki.ihe.net/index.php/QRPH_Registry#Profiles this wiki page] also)}}
 
{{R|QRPH Profiles |urn:ihe:qrph:xxxxx:yyyy| text/xml| 1.3.6.1.4.1.19376.1.7.Z ([[QRPH_Registry|QRPH_Registry]])}}
 
{{R|Birth and Fetal Death Reporting - LDS-VR |urn:ihe:qrph:LDS-VR:2013| text/xml| 1.3.6.1.4.1.19376.1.7.3.1.1.19.1.1 ([[QRPH_Registry|QRPH_Registry]])}}
 
{{R|BFDR Birth CDA document |urn:ihe:qrph:BFDR-Birth:2014| text/xml| 1.3.6.1.4.1.19376.1.7.3.1.1.19.2 ([[QRPH_Registry|QRPH_Registry]])}}
 
{{R|BFDR Fetal Death CDA document |urn:ihe:qrph:BFDR-FDeath:2014| text/xml| 1.3.6.1.4.1.19376.1.7.3.1.1.19.3 ([[QRPH_Registry|QRPH_Registry]])}}
 
{{R|Prescription Repository Query (PRQ) |urn:ihe:qrph:prq:2019| text/xml| 1.3.6.1.4.1.19376.1.7.3.1.1.30 ([[QRPH_Registry|QRPH_Registry]])}}
 
{{R|Vital Records Death Reporting |urn:ihe:qrph:vrdr:2013| text/xml| Vital Records Death Reporting Document (1.3.6.1.4.1.19376.1.7.3.1.1.23.1) ([[QRPH_Registry|QRPH_Registry]])}}
 
{{R|Medical Summary for VRDR Pre-pop |urn:ihe:qrph:ms-vrdr:2013| text/xml| Medical Summary for VRDR Pre-pop (1.3.6.1.4.1.19376.1.7.3.1.1.23.2) ([[QRPH_Registry|QRPH_Registry]])}}
 
 
{{RH|4|Anatomic Pathology Profiles}}
 
{{R|Pathology ??? | urn:ihe:pat:apsr:all:2010 | text/xml | . }}
 
{{R|Pathology ??? | urn:ihe:pat:apsr:cancer:all:2010 | text/xml | . }}
 
{{R|Pathology ??? | urn:ihe:pat:apsr:cancer:breast:2010 | text/xml | . }}
 
{{R|Pathology ??? | urn:ihe:pat:apsr:cancer:colon:2010 | text/xml | . }}
 
{{R|Pathology ??? | urn:ihe:pat:apsr:cancer:prostate:2010 | text/xml | . }}
 
{{R|Pathology ??? | urn:ihe:pat:apsr:cancer:thyroid:2010 | text/xml | . }}
 
{{R|Pathology ??? | urn:ihe:pat:apsr:cancer:lung:2010 | text/xml | . }}
 
{{R|Pathology ??? | urn:ihe:pat:apsr:cancer:skin:2010 | text/xml | . }}
 
{{R|Pathology ??? | urn:ihe:pat:apsr:cancer:kidney:2010 | text/xml | . }}
 
{{R|Pathology ??? | urn:ihe:pat:apsr:cancer:cervix:2010 | text/xml | . }}
 
{{R|Pathology ??? | urn:ihe:pat:apsr:cancer:endometrium:2010 | text/xml | . }}
 
{{R|Pathology ??? | urn:ihe:pat:apsr:cancer:ovary:2010 | text/xml | . }}
 
{{R|Pathology ??? | urn:ihe:pat:apsr:cancer:esophagus:2010 | text/xml | . }}
 
{{R|Pathology ??? | urn:ihe:pat:apsr:cancer:stomach:2010 | text/xml | . }}
 
{{R|Pathology ??? | urn:ihe:pat:apsr:cancer:liver:2010 | text/xml | . }}
 
{{R|Pathology ??? | urn:ihe:pat:apsr:cancer:pancreas 2010 | text/xml | . }}
 
{{R|Pathology ??? | urn:ihe:pat:apsr:cancer:testis:2010 | text/xml | . }}
 
{{R|Pathology ??? | urn:ihe:pat:apsr:cancer:urinary_bladder:2010 | text/xml | . }}
 
{{R|Pathology ??? | urn:ihe:pat:apsr:cancer:lip_oral_cavity:2010 | text/xml | . }}
 
{{R|Pathology ??? | urn:ihe:pat:apsr:cancer:pharynx:2010 | text/xml | . }}
 
{{R|Pathology ??? | urn:ihe:pat:apsr:cancer:salivary_gland:2010 | text/xml | . }}
 
{{R|Pathology ??? | urn:ihe:pat:apsr:cancer:larynx:2010 | text/xml | . }}
 
 
{{RH|4|Pharmacy Profiles}}
 
{{R|Pharmacy ??? | urn:ihe:pharm:pre:2010 | text/xml | . }}
 
{{R|Pharmacy ??? | urn:ihe:pharm:padv:2010 | text/xml | . }}
 
{{R|Pharmacy ??? | urn:ihe:pharm:dis:2010 | text/xml | . }}
 
{{R|Pharmacy ??? | urn:ihe:pharm:pml:2013 | text/xml | . }}
 
 
}}
 
 
=HL7 defined FormatCodes=
 
 
These codes are used with the IHE codesystem  '''1.3.6.1.4.1.19376.1.2.3'''. The codes were requested from the HL7 Structured Documents Workgroup by PCC, and so are proper IHE codes even though defined by HL7, as is evidence by their URN prefix of '''urn:hl7-org'''.
 
 
These codes are defined in HL7 at http://wiki.hl7.org/index.php?title=CDA_Format_Codes_for_IHE_XDS
 
 
These codes are part of the IHE FormatCodes ValueSet identified by 1.3.6.1.4.1.19376.1.2.7.1.
 
 
{{T|Display|Format Code|Media Type|Template ID|Title=HL7 Metadata by Profile|
 
Rows=
 
 
{{RH|4|HL7 defined FormatCodes}}
 
{{R|C-CDA 1.1 constraints using a structured body | urn:hl7-org:sdwg:ccda-structuredBody:1.1 | text/xml | See C-CDA R1.1}}
 
{{R|C-CDA 1.1 constraints using a non structured body | urn:hl7-org:sdwg:ccda-nonXMLBody:1.1 | text/xml | See C-CDA R1.1}}
 
{{R|C-CDA 2.1 constraints using a structured body | urn:hl7-org:sdwg:ccda-structuredBody:2.1 | text/xml | See C-CDA R2.1}}
 
{{R|C-CDA 2.1 constraints using a non structured body | urn:hl7-org:sdwg:ccda-nonXMLBody:2.1 | text/xml | See C-CDA R2.1}}
 
}}
 
 
[http://www.hl7.org/implement/standards/product_brief.cfm?product_id=408 HL7 C-CDA R2.1 Implementation Guide]
 
 
=Other non-FormatCode codes in CodeSystem 1.3.6.1.4.1.19376.1.2.3=
 
code system identifier (scheme): '''1.3.6.1.4.1.19376.1.2.3'''. These codes are not used in formatCode, they are used in '''evenCodeList'''.
 
 
These codes are '''not part of the IHE FormatCodes ValueSet''' identified by 1.3.6.1.4.1.19376.1.2.7.1.
 
 
{{T|Display|Code|XDW use|Title=XDW use|
 
Rows=
 
 
{{R|open | urn:ihe:iti:xdw:2011:eventCode:open | overall status of the workflow is open }}
 
{{R|closed | urn:ihe:iti:xdw:2011:eventCode:closed | overall status of the workflow is closed }}
 
 
}}
 
 
=DICOM defined FormatCodes=
 
code system identifier (scheme): '''1.2.840.10008.2.6.1'''
 
 
These codes are part of the IHE FormatCodes ValueSet identified by 1.3.6.1.4.1.19376.1.2.7.1.
 
 
{{T|Profile|Format Code|Media Type|Template ID|Title=DICOM Metadata by Profile|
 
Rows=
 
 
{{RH|4|DICOM defined FormatCodes}}
 
{{R|DICOM KOS (Image Manifest)(XDS-I) | 1.2.840.10008.5.1.4.1.1.88.59 | application/dicom | Not applicable }}
 
 
}}
 

Revision as of 11:19, 28 January 2021

The IHE FormatCode vocabulary is now managed in an Implementation Guide published using FHIR.

This FormatCode vocabulary represents:

  • Code System 1.3.6.1.4.1.19376.1.2.3
  • Value Set 1.3.6.1.4.1.19376.1.2.7.1