Resource DocumentReference - Examples

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

. Page versions: R5 R4B R4 R3 R2

6.4.6 Resource DocumentReference - Examples

6.4.6.1 General

Example of documentreference (id = "example")

Raw XML

<DocumentReference xmlns="http://hl7.org/fhir">
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p>
        <b>Generated Narrative</b>
      </p>
      <p>
        <b>masterIdentifier</b>: urn:oid:1.3.6.1.4.1.21367.2005.3.7
      </p>
      <p>
        <b>subject</b>: 
        <a href="patient-example-xcda.html">MRN = 12345 (usual); Henry Levin ; Male; birthDate: 24-Sep 1932; active</a>
      </p>
      <p>
        <b>type</b>: 
        <span title="Codes: {http://loinc.org 34108-1}">Outpatient Note</span>
      </p>
      <p>
        <b>author</b>: Sherry Dopplemeyer ; Primary Surgon; Orthopedic, Gerald Smitty ; Attending; Orthopedic
      </p>
      <p>
        <b>created</b>: 24-Dec 2005 9:35
      </p>
      <p>
        <b>indexed</b>: 24-Dec 2005 9:43
      </p>
      <p>
        <b>status</b>: current
      </p>
      <p>
        <b>description</b>: Physical
      </p>
      <p>
        <b>confidentiality</b>: 
        <span title="Codes: {http://ihe.net/xds/connectathon/confidentialityCodes 1.3.6.1.4.1.21367.2006.7.101}">Clinical-Staff</span>
      </p>
      <p>
        <b>primaryLanguage</b>: en-US
      </p>
      <p>
        <b>mimeType</b>: application/hl7-v3+xml
      </p>
      <p>
        <b>size</b>: 3654
      </p>
      <p>
        <b>hash</b>: da39a3ee5e6b4b0d3255bfef95601890afd80709
      </p>
      <p>
        <b>location</b>: 
        <a href="http://example.org/xds/mhd/Binary/@07a6483f-732b-461e-86b6-edb665c45510">http://example.org/xds/mhd/Binary/@07a6483f-732b-461e-86b6-edb665c45510</a>
      </p>
      <h3>Contexts</h3>
      <table class="grid">
        <tr>
          <td>
            <b>Event</b>
          </td>
          <td>
            <b>Period</b>
          </td>
          <td>
            <b>FacilityType</b>
          </td>
        </tr>
        <tr>
          <td>
            <span title="Codes: {http://ihe.net/xds/connectathon/eventCodes T-D8200}">Arm</span>
          </td>
          <td>23-Dec 2004 8:0 --&gt; 23-Dec 2004 8:1</td>
          <td>
            <span title="Codes: {http://www.ihe.net/xds/connectathon/healthcareFacilityTypeCodes Outpatient}">Outpatient</span>
          </td>
        </tr>
      </table>
    </div>
  </text>
  <contained><!--    Many XDS systems do not trak any id for the author. When systems don't do this, 
    the only option is for the author information to be contained in the Document Reference
        -->
    <Practitioner id="a1">
      <name>
        <family value="Dopplemeyer"/>
        <given value="Sherry"/>
      </name>
      <telecom>
        <system value="email"/>
        <value value="john.doe@healthcare.example.org"/>
      </telecom>
      <organization>
        <display value="Cleveland Clinic"/>
      </organization><!--   
      &lt;organization&gt;
        &lt;display value=&quot;Berea Community&quot;/&gt;
      &lt;/organization&gt;      
   -->
      <role>
        <text value="Primary Surgon"/>
      </role>
      <specialty>
        <text value="Orthopedic"/>
      </specialty>
    </Practitioner>
  </contained>
  <contained>
    <Practitioner id="a2">
      <name>
        <family value="Smitty"/>
        <given value="Gerald"/>
      </name>
      <telecom>
        <system value="email"/>
        <value value="john.doe@healthcare.example.org"/>
      </telecom>
      <organization>
        <display value="Cleveland Clinic"/>
      </organization><!--   
      &lt;organization&gt;
        &lt;display value=&quot;Parma Community&quot;/&gt;
      &lt;/organization&gt;      
   -->
      <role>
        <text value="Attending"/>
      </role>
      <specialty>
        <text value="Orthopedic"/>
      </specialty>
    </Practitioner>
  </contained>
  <masterIdentifier>
    <system value="urn:ietf:rfc:3986"/>
    <value value="urn:oid:1.3.6.1.4.1.21367.2005.3.7"/>
  </masterIdentifier>
  <subject>
    <reference value="Patient/xcda"/>
  </subject>
  <type>
    <coding>
      <system value="http://loinc.org"/>
      <code value="34108-1"/>
      <display value="Outpatient Note"/>
    </coding>
  </type>
  <author>
    <reference value="#a1"/>
  </author>
  <author>
    <reference value="#a2"/>
  </author>
  <created value="2005-12-24T09:35:00+11:00"/>
  <indexed value="2005-12-24T09:43:41+11:00"/>
  <status value="current"/>
  <description value="Physical"/>
  <confidentiality>
    <coding>
      <system value="http://ihe.net/xds/connectathon/confidentialityCodes"/>
      <code value="1.3.6.1.4.1.21367.2006.7.101"/>
      <display value="Clinical-Staff"/>
    </coding>
  </confidentiality>
  <primaryLanguage value="en-US"/>
  <mimeType value="application/hl7-v3+xml"/>
  <size value="3654"/>
  <hash value="da39a3ee5e6b4b0d3255bfef95601890afd80709"/>
  <location value="http://example.org/xds/mhd/Binary/@07a6483f-732b-461e-86b6-edb665c45510"/>
  <context>
    <event>
      <coding>
        <system value="http://ihe.net/xds/connectathon/eventCodes"/>
        <code value="T-D8200"/>
        <display value="Arm"/>
      </coding>
    </event>
    <period>
      <start value="2004-12-23T08:00:00"/>
      <end value="2004-12-23T08:01:00"/>
    </period>
    <facilityType>
      <coding>
        <system value="http://www.ihe.net/xds/connectathon/healthcareFacilityTypeCodes"/>
        <code value="Outpatient"/>
        <display value="Outpatient"/>
      </coding>
    </facilityType>
  </context>
</DocumentReference>

Example of documentreference

{
  "resourceType": "DocumentReference",
  "text": {
    "status": "generated",
    "div": "<div>\n      <p>\n        <b>Generated Narrative</b>\n      </p>\n      <p>\n        <b>masterIdentifier</b>: urn:oid:1.3.6.1.4.1.21367.2005.3.7\n      </p>\n      <p>\n        <b>subject</b>: \n        <a href=\"patient-example-xcda.html\">MRN = 12345 (usual); Henry Levin ; Male; birthDate: 24-Sep 1932; active</a>\n      </p>\n      <p>\n        <b>type</b>: \n        <span title=\"Codes: {http://loinc.org 34108-1}\">Outpatient Note</span>\n      </p>\n      <p>\n        <b>author</b>: Sherry Dopplemeyer ; Primary Surgon; Orthopedic, Gerald Smitty ; Attending; Orthopedic\n      </p>\n      <p>\n        <b>created</b>: 24-Dec 2005 9:35\n      </p>\n      <p>\n        <b>indexed</b>: 24-Dec 2005 9:43\n      </p>\n      <p>\n        <b>status</b>: current\n      </p>\n      <p>\n        <b>description</b>: Physical\n      </p>\n      <p>\n        <b>confidentiality</b>: \n        <span title=\"Codes: {http://ihe.net/xds/connectathon/confidentialityCodes 1.3.6.1.4.1.21367.2006.7.101}\">Clinical-Staff</span>\n      </p>\n      <p>\n        <b>primaryLanguage</b>: en-US\n      </p>\n      <p>\n        <b>mimeType</b>: application/hl7-v3+xml\n      </p>\n      <p>\n        <b>size</b>: 3654\n      </p>\n      <p>\n        <b>hash</b>: da39a3ee5e6b4b0d3255bfef95601890afd80709\n      </p>\n      <p>\n        <b>location</b>: \n        <a href=\"http://example.org/xds/mhd/Binary/@07a6483f-732b-461e-86b6-edb665c45510\">http://example.org/xds/mhd/Binary/@07a6483f-732b-461e-86b6-edb665c45510</a>\n      </p>\n      <h3>Contexts</h3>\n      <table class=\"grid\">\n        <tr>\n          <td>\n            <b>Event</b>\n          </td>\n          <td>\n            <b>Period</b>\n          </td>\n          <td>\n            <b>FacilityType</b>\n          </td>\n        </tr>\n        <tr>\n          <td>\n            <span title=\"Codes: {http://ihe.net/xds/connectathon/eventCodes T-D8200}\">Arm</span>\n          </td>\n          <td>23-Dec 2004 8:0 --&gt; 23-Dec 2004 8:1</td>\n          <td>\n            <span title=\"Codes: {http://www.ihe.net/xds/connectathon/healthcareFacilityTypeCodes Outpatient}\">Outpatient</span>\n          </td>\n        </tr>\n      </table>\n    </div>"
  },
  "contained": [
    {
      "resourceType": "Practitioner",
      "id": "a1",
      "name": {
        "family": [
          "Dopplemeyer"
        ],
        "given": [
          "Sherry"
        ]
      },
      "telecom": [
        {
          "system": "email",
          "value": "john.doe@healthcare.example.org"
        }
      ],
      "organization": {
        "display": "Cleveland Clinic"
      },
      "role": [
        {
          "text": "Primary Surgon"
        }
      ],
      "specialty": [
        {
          "text": "Orthopedic"
        }
      ]
    },
    {
      "resourceType": "Practitioner",
      "id": "a2",
      "name": {
        "family": [
          "Smitty"
        ],
        "given": [
          "Gerald"
        ]
      },
      "telecom": [
        {
          "system": "email",
          "value": "john.doe@healthcare.example.org"
        }
      ],
      "organization": {
        "display": "Cleveland Clinic"
      },
      "role": [
        {
          "text": "Attending"
        }
      ],
      "specialty": [
        {
          "text": "Orthopedic"
        }
      ]
    }
  ],
  "masterIdentifier": {
    "system": "urn:ietf:rfc:3986",
    "value": "urn:oid:1.3.6.1.4.1.21367.2005.3.7"
  },
  "subject": {
    "reference": "Patient/xcda"
  },
  "type": {
    "coding": [
      {
        "system": "http://loinc.org",
        "code": "34108-1",
        "display": "Outpatient Note"
      }
    ]
  },
  "author": [
    {
      "reference": "#a1"
    },
    {
      "reference": "#a2"
    }
  ],
  "created": "2005-12-24T09:35:00+11:00",
  "indexed": "2005-12-24T09:43:41+11:00",
  "status": "current",
  "description": "Physical",
  "confidentiality": [
    {
      "coding": [
        {
          "system": "http://ihe.net/xds/connectathon/confidentialityCodes",
          "code": "1.3.6.1.4.1.21367.2006.7.101",
          "display": "Clinical-Staff"
        }
      ]
    }
  ],
  "primaryLanguage": "en-US",
  "mimeType": "application/hl7-v3+xml",
  "size": 3654,
  "hash": "da39a3ee5e6b4b0d3255bfef95601890afd80709",
  "location": "http://example.org/xds/mhd/Binary/@07a6483f-732b-461e-86b6-edb665c45510",
  "context": {
    "event": [
      {
        "coding": [
          {
            "system": "http://ihe.net/xds/connectathon/eventCodes",
            "code": "T-D8200",
            "display": "Arm"
          }
        ]
      }
    ],
    "period": {
      "start": "2004-12-23T08:00:00",
      "end": "2004-12-23T08:01:00"
    },
    "facilityType": {
      "coding": [
        {
          "system": "http://www.ihe.net/xds/connectathon/healthcareFacilityTypeCodes",
          "code": "Outpatient",
          "display": "Outpatient"
        }
      ]
    }
  }
}