The Device resource implements the FHIR R4 DocumentReference specification and US Core v3.1.1 DocumentReference profile

Fields

Name Type Cardinality Required Description
masterIdentifier Identifier 0..1   Master Version Specific Identifier
identifier Identifier 0..*   Other identifiers for the document
status code 1..1 * current | superseded | entered-in-error - Binding
docStatus code 0..1   preliminary | final | appended | amended | entered-in-error
type CodeableConcept 1..1 * Kind of document - Binding
category CodeableConcept 1..* * Categorization of document - Binding
subject Reference(US Core Patient Profile) 1..1 * Who/what is the subject of the document
date instant 0..1   When this document reference was created
author Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile) 0..*   Who and/or what authored the document
authenticator Reference 0..1   Who/what authenticated the document
custodian Reference(US Core Organization Profile) 0..1   Organization which maintains the document
relatesTo BackboneElement 0..*   Relationships to other documents
description string 0..1   Human-readable description (title)
securityLabel CodeableConcept 0..*   Document security-tags
content BackboneElement 1..* * Document referenced
content.attachment Attachment 1..1 * Where to access the document
content.attachment.contentType code 1..1 * Mime type of the content, with charset etc.
context BackboneElement 0..*   Clinical context of document

Interactions

Read

Get an DocumentReference entry by id

GET /DocumentReference/:id

Example

Request

https://r4cert.medicasoft.us/api/fhir/DocumentReference/ee7085fe-bd34-1a5f-3ec1-073a8781b448

Response


  "resourceType": "DocumentReference",
  "masterIdentifier": {
    "system": "urn:ietf:rfc:3986",
    "value": "urn:uuid:f77b3546-0c99-0c27-6b8b-8ce1351cdae3"
  },
  "identifier": [
    {
      "value": "urn:uuid:f77b3546-0c99-0c27-6b8b-8ce1351cdae3",
      "system": "urn:ietf:rfc:3986"
    }
  ],
  "status": "superseded",
  "docStatus": "final",
  "type": {
    "coding": [
      {
        "code": "11488-4",
        "system": "http://loinc.org",
        "display": "Consultation note"
      }
    ],
    "text": "Consultation note"
  },
  "category": [
    {
      "coding": [
        {
          "code": "clinical-note",
          "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category",
          "display": "Clinical Note"
        }
      ],
      "text": "Clinical Note"
    }
  ],
  "subject": {
    "reference": "Patient/bcfa83df-ee8c-9721-cc07-bdcfc2b1e3f2"
  },
  "date": "1957-04-18T00:19:44.801-05:00",
  "author": [
    {
      "reference": "Practitioner/938fcb90-fd0a-351e-a874-a0cd3bdc81b9",
      "display": "Dr. Ingrid581 Jacobson885"
    }
  ],
  "custodian": {
    "reference": "Organization/b1ddf812-1fdd-3adf-b1d5-32cc8bd07ebb",
    "display": "BETH ISRAEL DEACONESS HOSPITAL - PLYMOUTH"
  },
  "content": [
    {
      "attachment": {
        "contentType": "text/plain",
        "data": "CjE5NTctMDQtMTgKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCldhbHRvbjE2NyBpcyBhIDE1IHllYXItb2xkIG5vbi1oaXNwYW5pYyB3aGl0ZSBtYWxlLiBQYXRpZW50IGhhcyBhIGhpc3Rvcnkgb2Ygc3RyZXB0b2NvY2NhbCBzb3JlIHRocm9hdCAoZGlzb3JkZXIpLCBhY3V0ZSBicm9uY2hpdGlzIChkaXNvcmRlciksIGxhY2VyYXRpb24gb2YgZm9vdCwgY2hpbGQgYXR0ZW50aW9uIGRlZmljaXQgZGlzb3JkZXIuCgojIFNvY2lhbCBIaXN0b3J5CiBQYXRpZW50IGhhcyBuZXZlciBzbW9rZWQgYW5kIGlzIGFuIGFsY29ob2xpYy4KClBhdGllbnQgY29tZXMgZnJvbSBhIG1pZGRsZSBzb2Npb2Vjb25vbWljIGJhY2tncm91bmQuIFBhdGllbnQgY3VycmVudGx5IGhhcyBIdW1hbmEuCgojIEFsbGVyZ2llcwpObyBLbm93biBBbGxlcmdpZXMuCgojIE1lZGljYXRpb25zCnBlbmljaWxsaW4gdiBwb3Rhc3NpdW0gMjUwIG1nIG9yYWwgdGFibGV0OyBhY2V0YW1pbm9waGVuIDMyNSBtZyBvcmFsIHRhYmxldDsgYXNwaXJpbiA4MSBtZyBvcmFsIHRhYmxldAoKIyBBc3Nlc3NtZW50IGFuZCBQbGFuClBhdGllbnQgaXMgcHJlc2VudGluZyB3aXRoIGNvbmN1c3Npb24gd2l0aCBubyBsb3NzIG9mIGNvbnNjaW91c25lc3MuIAoKIyMgUGxhbgoKVGhlIHBhdGllbnQgd2FzIHBsYWNlZCBvbiBhIGNhcmVwbGFuOgotIGhlYWQgaW5qdXJ5IHJlaGFiaWxpdGF0aW9uCg=="
      },
      "format": {
        "system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem",
        "code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",
        "display": "mimeType Sufficient"
      }
    }
  ],
  "context": {
    "encounter": [
      {
        "reference": "Encounter/1cc3365a-46f4-3ab0-dd9d-d8a8b79af6cd"
      }
    ],
    "period": {
      "start": "1957-04-18T00:19:44-05:00",
      "end": "1957-04-18T01:19:44-05:00"
    }
  },
  "id": "ee7085fe-bd34-1a5f-3ec1-073a8781b448"
}

Query DocumentReference resources

GET /DocumentReference?:query_parameters

Parameters

Name Type Description
securitylabel token Document security-tags
subject reference Who/what is the subject of the document
description string Human-readable description (title)
language token Human language of the content (BCP-47)
type token Kind of document (LOINC if possible)
relation token replaces | transforms | signs | appends
patient reference Who/what is the subject of the document
event token Main clinical acts documented
category token Categorization of document
authenticator reference Who/what authenticated the document
identifier token Master Version Specific Identifier
period date Time of service that is being documented
custodian reference Organization which maintains the document
author reference Who and/or what authored the document
date instant When the document reference was created.
format token Format/content rules for the document
encounter reference Context of the document content
location uri Uri where the data can be found
relatesto reference Target of the relationship
facility token Kind of facility where patient was seen
status token current | superseded | entered-in-error
_revinclude   Provenance:target

Errors

Code Description
400 Invalid parameters
404 Resource not found

Profiles

The DocumentReference type field supports the full US Core DocumentReference Type value set including the following clinical note types and diagnostic report narratives:

  1. Discharge summary (18842-5)
  2. Consult note (11488-4)
  3. History and physical note (34117-2)
  4. Progress note (11506-3)
  5. Procedure note (28570-0)
  6. Cardiology / Laboratory Report (LP29708-2)
  7. Pathology Report (LP7839-6)
  8. Radiology / Immaging Narrative (LP29684-5)