This page is part of the FHIR Specification (v0.11: DSTU 1 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

XDS profile for Document Reference

The XDS profile describes in detail how a DocumentReference resource is used in the context of XDS. A FHIR DocumentReference resource may be used as a facade to an existing XDS server, such as is used for the IHE MHD specification, or it can be used the other way around, where the XDS functionality is implemented using a FHIR based server.

The FHIR DocumentReference is based on the functionality defined by XDS, but differs from XDS in some significant ways:

This profile was published on Sun, Jun 24, 2012 00:00+1000 as a draft by HL7 , and profiles the DocumentReference Resource

The id of this profile is xds

Content 

<!-- Resources -->
<!-- DocumentReference -->
<DocumentReference xmlns="http://hl7.org/fhir">
 <!-- from Element: extension -->
 <extension><!-- 0..* Extension Additional Content defined by implementations --></extension>
 <text><!-- 0..1 Narrative Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <masterIdentifier><!-- 1..1 Identifier XDSDocumentEntry.uniqueId --></masterIdentifier>
 <identifier><!-- 0..0 Identifier Other identifiers for the document --></identifier>
 <subject><!-- 1..1 Resource(Patient) XDSDocumentEntry.patientId + sourcePatientId/sourcePatientInfo --></subject>
 <type><!-- 1..1 CodeableConcept XDSDocumentEntry.classCode --></type>
 <subtype><!-- 1..1 CodeableConcept XDSDocumentEntry.typeCode --></subtype>
 <author><!-- 1..* Resource(Practitioner|Device) XDSDocumentEntry.author --></author>
 <custodian><!-- 0..0 Resource(Organization) n/a --></custodian>
 <authenticator><!-- 0..1 Resource(Practitioner) ?? --></authenticator>
 <created value="[dateTime]"/><!-- 1..1 XDSDocumentEntry.creationTime -->
 <indexed value="[instant]"/><!-- 1..1 XDS submission time or XDSDocumentEntry.creationTime  if unknown -->
 <status value="[code]"/><!-- 1..1 implied by XDS workflow -->
 <docStatus><!-- 0..0 CodeableConcept Status of the underlying document --></docStatus>
 <supercedes><!-- 0..0 Resource(DocumentReference) todo --></supercedes>
 <description value="[string]"/><!-- 0..1 ExtrinsicObject/Name -->
 <confidentiality><!-- 1..1 CodeableConcept XDSDocumentEntry.confidentialityCode --></confidentiality>
 <primaryLanguage value="[code]"/><!-- 0..1 XDSDocumentEntry.languageCode -->
 <mimeType value="[code]"/><!-- 1..1 XDSDocumentEntry.mimeType -->
 <format><!-- 1..1 CodeableConcept XDSDocumentEntry.formatCode --></format>
 <size value="[integer]"/><!-- 0..1 XDSDocumentEntry.size -->
 <hash value="[string]"/><!-- 0..1 XDSDocumentEntry.hash -->
 <location value="[uri]"/><!-- 0..1 repository location (by implication & configuration) -->
 <service>  <!-- 0..0 can be determined from repository location + parameters -->
 </service>
 <context>  <!-- 0..1 (if needed) -->
  <code><!-- 0..* CodeableConcept XDSDocumentEntry.eventCodeList --></code>
  <period><!-- 1..1 Period XDSDocumentEntry.serviceStartTime & XDSDocumentEntry.serviceStopTime --></period>
  <facilityType><!-- 0..1 CodeableConcept XDSDocumentEntry.healthCareFacilityTypeCode --></facilityType>
 </context>
</DocumentReference>

<!-- Extensions -->
<extension> <!--  0..1 Context: Resource = DocumentReference -->
 <url value="http://hl7.org/fhir/xds#homeCommunityId"/>
 <valueUri value="[uri]"/><!-- XDSDocumentEntry.homeCommunityId -->
</extension>

<extension> <!--  1..1 Context: Resource = DocumentReference -->
 <url value="http://hl7.org/fhir/xds#repositoryUniqueId"/>
 <valueUri value="[uri]"/><!-- XDSDocumentEntry.repositoryUniqueId -->
</extension>

<extension> <!--  1..1 Context: Resource = DocumentReference -->
 <url value="http://hl7.org/fhir/xds#practiceSettingCode"/>
 <valueCoding><!--  0..1  Coding XDSDocumentEntry.practiceSettingCode --> </valueCoding>
</extension>

<extension> <!--  0..1 Context: Resource = DocumentReference -->
 <url value="http://hl7.org/fhir/xds#comments"/>
 <valueString value="[string]"/><!-- XDSDocumentEntry.comments -->
</extension>

<extension> <!--  0..* Context: Resource = DocumentReference -->
 <url value="http://hl7.org/fhir/xds#relationship"/>
 <!-- Extensions: #relationship.type, #relationship.target --> 
</extension>

<extension> <!--  1..1 Context: Extension = http://hl7.org/fhir/xds#relationship -->
 <url value="http://hl7.org/fhir/xds#relationship.type"/>
 <valueCode value="[code]"/><!-- APND | RPLC | XFRM | XFRM_RPLC | signs -->
</extension>

<extension> <!--  1..1 Context: Extension = http://hl7.org/fhir/xds#relationship -->
 <url value="http://hl7.org/fhir/xds#relationship.target"/>
 <valueResourceReference><!--  0..1  Resource(DocumentReference) Target Document --> </valueResourceReference>
</extension>

This profile as a Resource Profile (formatted)

Terminology Bindings

PathDefinitionTypeReference
[xds].extensions.practiceSettingCode A code specifying the clinical specialty where the act that resulted in the document was performedExamplehttp://hl7.org/fhir/vs/xds-practice-codes
[xds].extensions.relationship.type The kind of relationship between two XDS documentsFixedhttp://hl7.org/fhir/xds-relationship-type

.

Example

Example Instance "Example for Profile XDS profile for Document Reference"

<feed xmlns="http://www.w3.org/2005/Atom">
  <title>XDS Submission - prepared by Health Intersections Test Script</title>
  <id>urn:uuid:02f06039-da24-4585-953b-0e9da4e79f41</id>
  <updated>2013-07-01T13:11:33Z</updated>
  <author>
    <name>XDS --&gt; FHIR Reference Bridge</name>
    <uri>http://www.healthintersections.com.au/xds2fhir.js</uri>
  </author>
  <entry>
    <title>Document Reference (XDS Entry)</title>
    <id>cid:f6791f11-ef7c-4877-a92b-adf7df4948a6@healthintersections.com.au</id>
    <link href="cid:f6791f11-ef7c-4877-a92b-adf7df4948a6@healthintersections.com.au" rel="self"/>
    <updated>2013-07-01T13:11:33Z</updated>
    <content type="text/xml">
      <DocumentReference xmlns="http://hl7.org/fhir">
        <extension>
          <url value="http://hl7.org/fhir/xds#practiceSettingCode"/>
          <valueCodeableConcept>
            <coding>
              <system value="http://ihe.net/connectathon/practiceSettingCodes"/>
              <code value="General Medicine"/>
              <display value="General Medicine"/>
            </coding>
          </valueCodeableConcept>
        </extension>
        <text>
          <status value="generated"/>
          <div xmlns="http://www.w3.org/1999/xhtml">
            <a href="http://localhost:9556/svc/fhir/binary/@1e404af3-077f-4bee-b7a6-a9be97e1ce32">Document: urn:oid:129.6.58.92.88336</a>undefined, created 24/12/2005</div>
        </text>
        <masterIdentifier>
          <system value="urn:ietf:rfc:3986"/>
          <key value="urn:oid:129.6.58.92.88336"/>
        </masterIdentifier>
        <subject>
          <type value="Patient"/>
          <reference value="http://localhost/patient/search?identifier=http://acme.org/xds/patients!89765a87b"/>
        </subject>
        <type>
          <coding>
            <system value="http://ihe.net/connectathon/classCodes"/>
            <code value="History and Physical"/>
            <display value="History and Physical"/>
          </coding>
        </type>
        <author>
          <type value="Practitioner"/>
          <reference value="cid:af500afb-d680-4fa0-bcf2-ba1f5c5b096d@healthintersections.com.au"/>
        </author>
        <author>
          <type value="Practitioner"/>
          <reference value="cid:51b578b4-3ccb-4e67-b0dc-ef519d82ef2d@healthintersections.com.au"/>
        </author>
        <created value="2005-12-24"/>
        <indexed value="2013-07-01T23:11:33+10:00"/>
        <status value="current"/>
        <description value="Physical"/>
        <primaryLanguage value="en-us"/>
        <mimeType value="text/plain"/>
        <format>
          <coding>
            <system value="http://ihe.net/connectathon/formatCodes"/>
            <code value="CDAR2/IHE 1.0"/>
            <display value="CDAR2/IHE 1.0"/>
          </coding>
        </format>
        <location value="http://localhost:9556/svc/fhir/binary/@1e404af3-077f-4bee-b7a6-a9be97e1ce32"/>
        <context>
          <period>
            <start value="2004-12-23T08:00:00"/>
            <end value="2004-12-23T08:01:00"/>
          </period>
        </context>
      </DocumentReference>
    </content>
  </entry>
  <entry>
    <title>patient record</title>
    <id>http://localhost/patient/search?identifier=http://acme.org/xds/patients!89765a87b</id>
    <link href="http://localhost/patient/search?identifier=http://acme.org/xds/patients!89765a87b" rel="self"/>
    <updated>2013-07-01T13:11:33Z</updated>
    <content type="text/xml">
      <Patient xmlns="http://hl7.org/fhir">
        <text>
          <status value="generated"/>
          <div xmlns="http://www.w3.org/1999/xhtml">Person DOE, John, M, dob: 27/05/1956</div>
        </text>
        <identifier>
          <system value="usual"/>
          <key value="MRN"/>
        </identifier>
        <name>
            <use value="usual"/>
            <text value="DOE, John"/>
            <family value="Doe"/>
            <given value="John"/>
          </name>
        <birthDate value="1956-05-27"/>

      </Patient>
    </content>
    <summary type="xhtml">
      <div xmlns="http://www.w3.org/1999/xhtml">Person DOE, John, M, dob: 27/05/1956</div>
    </summary>
  </entry>
  <entry>
    <title>Author</title>
    <id>cid:af500afb-d680-4fa0-bcf2-ba1f5c5b096d@healthintersections.com.au</id>
    <link href="cid:af500afb-d680-4fa0-bcf2-ba1f5c5b096d@healthintersections.com.au" rel="self"/>
    <updated>2013-07-01T13:11:33Z</updated>
    <content type="text/xml">
      <Practitioner xmlns="http://hl7.org/fhir">
        <extension>
          <url value="http://healthintersections.com.au/fhir/extensions#xds-author-institution-repeats"/>
          <valueResource>
            <display value="Parma Community"/>
          </valueResource>
        </extension>
        <text>
          <status value="generated"/>
          <div xmlns="http://www.w3.org/1999/xhtml">Author Person @ Cleveland Clinic</div>
        </text>
        <identifier>
          <system value="usual"/>
        </identifier>
          <name>
            <use value="usual"/>
            <family value="Smitty"/>
            <given value="Gerald"/>
          </name>
        
        <organization>
          <display value="Cleveland Clinic"/>
        </organization>
        <role>
          <coding>
            <code value="Attending"/>
          </coding>
        </role>
        <specialty>
          <coding>
            <code value="Orthopedic"/>
          </coding>
        </specialty>
      </Practitioner>
    </content>
    <summary type="xhtml">
      <div xmlns="http://www.w3.org/1999/xhtml">Author Person @ Cleveland Clinic</div>
    </summary>
  </entry>
  <entry>
    <title>Author</title>
    <id>cid:51b578b4-3ccb-4e67-b0dc-ef519d82ef2d@healthintersections.com.au</id>
    <link href="cid:51b578b4-3ccb-4e67-b0dc-ef519d82ef2d@healthintersections.com.au" rel="self"/>
    <updated>2013-07-01T13:11:33Z</updated>
    <content type="text/xml">
      <Practitioner xmlns="http://hl7.org/fhir">
        <extension>
          <url value="http://healthintersections.com.au/fhir/extensions#xds-author-institution-repeats"/>
          <valueResource>
            <display value="Berea Community"/>
          </valueResource>
        </extension>
        <text>
          <status value="generated"/>
          <div xmlns="http://www.w3.org/1999/xhtml">Author Person @ Cleveland Clinic</div>
        </text>
        <identifier>
          <system value="usual"/>
        </identifier>
          <name>
            <use value="usual"/>
            <family value="Dopplemeyer"/>
            <given value="Sherry"/>
          </name>
        
        <organization>
          <display value="Cleveland Clinic"/>
        </organization>
        <role>
          <coding>
            <code value="Primary Surgon"/>
          </coding>
        </role>
        <specialty>
          <coding>
            <code value="Orthopedic"/>
          </coding>
        </specialty>
      </Practitioner>
    </content>
    <summary type="xhtml">
      <div xmlns="http://www.w3.org/1999/xhtml">Author Person @ Cleveland Clinic</div>
    </summary>
  </entry>
  <entry>
    <title>binary document</title>
    <id>urn:uuid:1e404af3-077f-4bee-b7a6-a9be97e1ce32</id>
    <link href="urn:uuid:1e404af3-077f-4bee-b7a6-a9be97e1ce32" rel="self"/>
    <updated>2013-07-01T13:11:33Z</updated>
    <content type="text/xml">
      <Binary contentType="text/plain" xmlns="http://hl7.org/fhir">YXNkYXNkYXNkYXNkYXNk</Binary>
    </content>
  </entry>
</feed>