Developer documentation‎ > ‎FHIR API‎ > ‎Roadmap‎ > ‎

DocumentReference

https://www.hl7.org/fhir/documentreference.html

Status

In development. API spec subject to change.

Overview

A DocumentReference is used to capture information about documents authored outside PKB and then subsequently sent to us. For example, a discharge summary sent in an MDM T02.

A DocumentReference will be generated for each [[Message]] where [[Message.Type]] = DOCUMENT.

Relevant Entities

Endpoints

InteractionHTTPURLSupported Search ParamsPermitted User TypesDescriptionExamples
searchGET/DocumentReference
  • patient. Required. Multi-value support: none. Modifier support: [<type>]
  • encounter. Required. Multi-value support: none. Modifier support: [<type>].
  • Patient
  • Professional
Retrieve DocumentReference resources for a specific Encounter./DocumentReference?patient=Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a&encounter=Encounter/8b1e7011-bcbb-4ab8-91d3-fd5aecd5a774

Mappings

FHIRPKBNotes
Resource id[[Message.Data Point ID]] 
DocumentReference.status<conditional>
If there is another DocumentReference with the same [[Message.External Data Point ID]] for the same [[Source.Source Organisation]] but a more recent [[Message.Persisted Timestamp]]: "superseded"
Else: "current"
DocumentReference.type
  • type: CodeableConcept
    • coding[0]: Coding
      • code = [[Message.Document Type]]
      • system = "http://fhir.patientsknowbest.com/codesystem/document-type"
Coding.code value mappings (PKB → FHIR):
  • DISCHARGE_SUMMARY → DISCHARGE_SUMMARY
  • CLINIC_LETTER → CLINIC_LETTER
  • REFERRAL_LETTER → REFERRAL_LETTER
  • APPOINTMENT_LETTER → APPOINTMENT_LETTER
  • ADMISSION_TCI_LETTER → ADMISSION_TCI_LETTER
  • MULTI_DISCIPLINARY_TEAM_MEETING_NOTES → MULTI_DISCIPLINARY_TEAM_MEETING_NOTES


DocumentReference.subject
  • subject: Reference
    • reference = the relative URL of the Patient resource
    • display = [[User.Title]] [[User.Given Name]] [[User.Family Name]]
 
DocumentReference.indexed[[Message.Persisted Timestamp]] 
DocumentReference.context
  • context: BackboneElement
    • encounter: Reference
      • reference = the relative URL of the Encounter resource
 
Comments