Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

Example DocumentReference/example (JSON)

Orders and Observations Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: Device, Encounter, Patient, Practitioner, RelatedPerson

Raw JSON (canonical form + also see JSON Format Specification)

Generic example

{
  "resourceType" : "DocumentReference",
  "id" : "example",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative: DocumentReference</b><a name=\"example\"> </a></p><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\">Resource DocumentReference &quot;example&quot; </p></div><p><b>Supporting info</b>: <a href=\"patient-example-xcda.html\">Patient/xcda</a> &quot;Henry LEVIN&quot;</p><p><b>DocumentReference Source Patient</b>: <a href=\"patient-example-xcda.html\">Patient/xcda</a> &quot;Henry LEVIN&quot;</p><p><b>identifier</b>: entryUUID:\u00a0urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234, uniqueId:\u00a0urn:oid:1.3.6.1.4.1.21367.2005.3.7</p><p><b>status</b>: current</p><p><b>docStatus</b>: preliminary</p><p><b>type</b>: Outpatient Note <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://loinc.org/\">LOINC</a>#34108-1)</span></p><p><b>category</b>: History and Physical <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (classCodes#History and Physical)</span></p><p><b>subject</b>: <a href=\"patient-example-xcda.html\">Patient/xcda</a> &quot;Henry LEVIN&quot;</p><p><b>context</b>: <a href=\"encounter-example-xcda.html\">Encounter/xcda</a></p><h3>Events</h3><table class=\"grid\"><tr><td>-</td><td><b>Concept</b></td></tr><tr><td>*</td><td>Arm <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (eventCodes#T-D8200)</span></td></tr></table><p><b>facilityType</b>: Outpatient <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (healthcareFacilityTypeCodes#Outpatient)</span></p><p><b>practiceSetting</b>: General Medicine <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (practiceSettingCodes#General Medicine)</span></p><p><b>period</b>: 2004-12-23T08:00:00+11:00 --&gt; 2004-12-23T08:01:00+11:00</p><p><b>date</b>: 24 Dec 2005, 9:43:41 am</p><p><b>author</b>: </p><ul><li><a href=\"practitioner-example-xcda1.html\">Practitioner/xcda1</a> &quot;Sherry DOPPLEMEYER&quot;</li><li><a name=\"a2\"> </a></li></ul><blockquote><p/><p><a name=\"a2\"> </a></p><p><b>name</b>: Gerald Smitty </p></blockquote><h3>Attesters</h3><table class=\"grid\"><tr><td>-</td><td><b>Mode</b></td><td><b>Party</b></td></tr><tr><td>*</td><td>Official <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"codesystem-composition-attestation-mode.html\">Composition Attestation Mode</a>#official)</span></td><td><a href=\"organization-example-f001-burgers.html\">Organization/f001</a> &quot;Burgers University Medical Center&quot;</td></tr></table><p><b>custodian</b>: <a href=\"organization-example-f001-burgers.html\">Organization/f001</a> &quot;Burgers University Medical Center&quot;</p><h3>RelatesTos</h3><table class=\"grid\"><tr><td>-</td><td><b>Code</b></td><td><b>Target</b></td></tr><tr><td>*</td><td>Appends <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"codesystem-document-relationship-type.html\">Document Relationship Type</a>#appends)</span></td><td><a href=\"documentreference-example.html\">DocumentReference/example</a></td></tr></table><p><b>description</b>: Physical</p><p><b>securityLabel</b>: very restricted <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/5.1.0/CodeSystem-v3-Confidentiality.html\">Confidentiality</a>#V)</span></p><blockquote><p><b>content</b></p><h3>Attachments</h3><table class=\"grid\"><tr><td>-</td><td><b>ContentType</b></td><td><b>Language</b></td><td><b>Url</b></td><td><b>Size</b></td><td><b>Hash</b></td><td><b>Title</b></td><td><b>Creation</b></td></tr><tr><td>*</td><td>application/hl7-v3+xml</td><td>en-US</td><td><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></td><td>3654</td><td>2jmj7l5rSw0yVb/vlWAYkK/YBwk=</td><td>Physical</td><td>2005-12-24T09:35:00+11:00</td></tr></table><h3>Profiles</h3><table class=\"grid\"><tr><td>-</td><td><b>Value[x]</b></td></tr><tr><td>*</td><td>History and Physical Specification (Details: urn:oid:1.3.6.1.4.1.19376.1.2.3 code urn:ihe:pcc:handp:2008 = 'urn:ihe:pcc:handp:2008', stated as 'History and Physical Specification')</td></tr></table></blockquote></div>"
  },
  "contained" : [{
    "resourceType" : "Practitioner",
    "id" : "a2",
    "name" : [{
      "family" : "Smitty",
      "given" : ["Gerald"]
    }]
  }],
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/workflow-supportingInfo",
    "valueReference" : {
      "reference" : "Patient/xcda",
      "identifier" : {
        "system" : "urn:ietf:rfc:3986",
        "value" : "urn:oid:1.3.6.1.4.1.21367.2005.3.7.2345"
      }
    }
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/documentreference-sourcepatient",
    "valueReference" : {
      "reference" : "Patient/xcda"
    }
  }],
  "identifier" : [{
    "type" : {
      "text" : "entryUUID"
    },
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234"
  },
  {
    "type" : {
      "text" : "uniqueId"
    },
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:1.3.6.1.4.1.21367.2005.3.7"
  }],
  "status" : "current",
  "docStatus" : "preliminary",
  "type" : {
    "coding" : [{
      "system" : "http://loinc.org",
      "code" : "34108-1",
      "display" : "Outpatient Note"
    }]
  },
  "category" : [{
    "coding" : [{
      "system" : "http://ihe.net/xds/connectathon/classCodes",
      "code" : "History and Physical",
      "display" : "History and Physical"
    }]
  }],
  "subject" : {
    "reference" : "Patient/xcda"
  },
  "context" : [{
    "reference" : "Encounter/xcda"
  }],
  "event" : [{
    "concept" : {
      "coding" : [{
        "system" : "http://ihe.net/xds/connectathon/eventCodes",
        "code" : "T-D8200",
        "display" : "Arm"
      }]
    }
  }],
  "facilityType" : {
    "coding" : [{
      "system" : "http://www.ihe.net/xds/connectathon/healthcareFacilityTypeCodes",
      "code" : "Outpatient",
      "display" : "Outpatient"
    }]
  },
  "practiceSetting" : {
    "coding" : [{
      "system" : "http://www.ihe.net/xds/connectathon/practiceSettingCodes",
      "code" : "General Medicine",
      "display" : "General Medicine"
    }]
  },
  "period" : {
    "start" : "2004-12-23T08:00:00+11:00",
    "end" : "2004-12-23T08:01:00+11:00"
  },
  "date" : "2005-12-24T09:43:41+11:00",
  "author" : [{
    "reference" : "Practitioner/xcda1"
  },
  {
    "reference" : "#a2"
  }],
  "attester" : [{
    "mode" : {
      "coding" : [{
        "system" : "http://hl7.org/fhir/composition-attestation-mode",
        "code" : "official"
      }]
    },
    "party" : {
      "reference" : "Organization/f001"
    }
  }],
  "custodian" : {
    "reference" : "Organization/f001"
  },
  "relatesTo" : [{
    "code" : {
      "coding" : [{
        "system" : "http://hl7.org/fhir/document-relationship-type",
        "code" : "appends"
      }]
    },
    "target" : {
      "reference" : "DocumentReference/example"
    }
  }],
  "description" : "Physical",
  "securityLabel" : [{
    "coding" : [{
      "system" : "http://terminology.hl7.org/CodeSystem/v3-Confidentiality",
      "code" : "V",
      "display" : "very restricted"
    }]
  }],
  "content" : [{
    "attachment" : {
      "contentType" : "application/hl7-v3+xml",
      "language" : "en-US",
      "url" : "http://example.org/xds/mhd/Binary/07a6483f-732b-461e-86b6-edb665c45510",
      "size" : "3654",
      "hash" : "2jmj7l5rSw0yVb/vlWAYkK/YBwk=",
      "title" : "Physical",
      "creation" : "2005-12-24T09:35:00+11:00"
    },
    "profile" : [{
      "valueCoding" : {
        "system" : "urn:oid:1.3.6.1.4.1.19376.1.2.3",
        "code" : "urn:ihe:pcc:handp:2008",
        "display" : "History and Physical Specification"
      }
    }]
  }]
}

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.