Image Document Reference

Document reference requests and examples

Parameters

Parameter Is Required Description
_id This, or patient. The logical resource ID associated with the resource.
patient This, or ID The patient who has the document referenced.
category No The categorization for the type of document referenced. Example: category=clinical-note.
type No The kind of document referenced. Example: https://loinc.org/11488-4.
date No Date range into which the document referenced falls. Example: date=ge2020-01-01.
_revinclude No A request to include any Provenance resource in the bundle.

Document Reference Requests

Document Reference by Patient, Category, Date, and Type

Patient:
 GET: 'https://api.practicestudio.net/patientportal/fhir/DocumentReference?patient=Patient/{Patient_ID}'

Patient and Type:
 GET: 'https://api.practicestudio.net/patientportal/fhir/DocumentReference?patient={Patient_ID}&type=11488-4'

Patient, Category, and Date:
 GET: 'https://api.practicestudio.net/patientportal/fhir/DocumentReference?category=clinical-note&date=2022-07-29T13:05:00-05:00&patient={Patient_ID}'

Patient and Category:
 GET: 'https://api.practicestudio.net/patientportal/fhir/DocumentReference?category=clinical-note&patient={Patient_ID}'

Document Reference by Resource ID

GET: 'https://api.practicestudio.net/patientportal/fhir/DocumentReference?_id={Resource_ID}'

Document Reference Example Response

Example Document Reference JSON Response:


{
  "resourceType": "Bundle",
  "meta": {
    "lastUpdated": "2022-08-11T14:47:37.6105314-05:00"
  },
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://api.practicestudio.net/patientportal/fhir/DocumentResource?patient=000034"
    }
  ],
  "entry": [
    {
      "resource": {
        "resourceType": "DocumentReference",
        "id": "000034",
        "identifier": [
          {
            "value": "9899d005-c558-4380-a778-69298e40a2e2"
          }
        ],
        "status": "current",
        "docStatus": "preliminary",
        "type": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "11488-4",
              "display": "Consultation note",
              "userSelected": false
            }
          ]
        },
        "category": [
          {
            "coding": [
              {
                "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category",
                "code": "clinical-note",
                "display": "Clinical Note",
                "userSelected": false
              }
            ]
          }
        ],
        "subject": {
          "reference": "Patient/000034"
        },
        "date": "2022-07-29T13:05:00-05:00",
        "author": [
          {
            "reference": "Practitioner/10000003"
          }
        ],
        "custodian": {
          "reference": "Organization/10000001"
        },
        "content": [
          {
            "attachment": {
              "contentType": "text/plain",
              "language": "en-US",
              "data": "Q29uc3VsdGF0aW9uIE5vdGU6IFRoaXMgaXMgYSBjb25zdWx0YXRpb24gbm90ZS4="
            },
            "format": {
              "userSelected": false
            }
          }
        ],
        "context": {
          "encounter": [
            {
              "reference": "Encounter/10096677"
            }
          ],
          "period": {
            "start": "2022-07-29",
            "end": "2022-07-29"
          }
        }
      },
      "search": {
        "mode": "match",
        "score": 1
      }
    }
  ]
}