DocumentReference

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

Status

Released. Further enhancements planned.

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.

Relevant PKB Entities

Endpoints

InteractionHTTPURLSupported Search ParamsPermitted User TypesDescriptionExamples (more)
searchGET/DocumentReference
  • created. Conditional. Multi-value support: AND. Modifier support: none. Prefix support: [eq, gt, lt, ge, le].
  • document-status. Optional. Multi-value support: none. Modifier support: none. Definition: http://fhir.patientsknowbest.com/searchparameter/document-status
  • indexed. Conditional. Multi-value support: AND. Modifier support: none. Prefix support: [eq, gt, lt, ge, le].
  • patient. Conditional. Multi-value support: none. Modifier support: [<type>].
  • source-organisation. Optional. Multi-value support: none. Modifier support: [<type>]. Definition: http://fhir.patientsknowbest.com/searchparameter/source-organisation
  • _revinclude=Provenance:target
  • Patient
  • Professional
Retrieve DocumentReference resources for a specific patient, or that were indexed on a given date.

In addition, can optionally include source information.
/DocumentReference?indexed=2018-08-01

/DocumentReference?indexed=2018-08-01&document-status=http://fhir.patientsknowbest.com/codesystem/document-status|READ

/DocumentReference?indexed=2018-08-01&source-organisation=Organization/32272c1d-4545-4083-a86e-1b3b8315f374

/DocumentReference?indexed=2018-08-01&_revinclude=Provenance:target

/DocumentReference?patient=Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a

/DocumentReference?patient=Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a&created=2019-03-01

Mappings

FHIRPKBNotes
Resource id[[Document.Data Point ID]] 
Resource meta
  • meta: Meta
    • extension[0]
      • url = "http://fhir.patientsknowbest.com/structuredefinition/document-status"
      • valueCoding: Coding
        • system = "http://fhir.patientsknowbest.com/codesystem/document-status"
        • code = [[Document.Status]]
    • lastUpdated = [[Data Point.Persisted Timestamp]]
    • security: Coding
      • system = "http://fhir.patientsknowbest.com/codesystem/privacy-label"
      • code = [[Data Point.Privacy Label]]
[[Document.Status]] code mappings (PKB → FHIR):
  • UNREAD → UNREAD
  • READ → READ
[[Data Point.Privacy Label]] code mappings (PKB → FHIR):
  • GENERAL_HEALTH → GENERAL_HEALTH
  • MENTAL_HEALTH → MENTAL_HEALTH
  • SEXUAL_HEALTH → SEXUAL_HEALTH
  • SOCIAL_CARE → SOCIAL_CARE

DocumentReference.extension
  • extension[0]: Extension
    • url = "http://fhir.patientsknowbest.com/structuredefinition/specialty"
    • valueCoding: Coding
      • code = [[Data Point.Specialty]]
      • display = Resolve( [[DataPoint.Specialty]] )
The "Resolve()" notation indicates a lookup will be performed into the optional, customer-provided code set. If a match is found, the corresponding display value will be used.

See here for more information.
DocumentReference.identifier
  • identifier: Identifier
    • value = [[Document.External Data Point ID]]
    • assigner: Reference
      • reference = the relative URL of the Organization resource.
      • display = [[Organisation.Name]]
The assigner reference will represent the PKB Organisation even if the source PKB Team is known, since external IDs are tracked at the level of the Organisation.
DocumentReference.status<conditional>
If there is another DocumentReference with the same [[Document.External Data Point ID]] for the same [[Source.Source Organisation]] but a more recent [[Document.Persisted Timestamp]]: "superseded"
Else: "current"
DocumentReference.type
  • type: CodeableConcept
    • coding[0]: Coding
      • code = [[Document.Document Type]]
      • system = "http://fhir.patientsknowbest.com/codesystem/document-type"
[[Document.Document Type]] code 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.created[[Document.Timestamp]] 
DocumentReference.indexed[[Document.Persisted Timestamp]] 
DocumentReference.content
  • content: BackboneElement
    • attachment:  Attachment
      • creation = [[Document.Timestamp]]
 
Subpages (1): Examples
Comments