Versions Compared

Version Old Version 1 New Version Current
Changes made by

Rodolfo Melia

Carlos

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

FHIR resource link

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

5.0 - ?

FHIR definition

(based on 4.3)

a reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. Includes formal patient centric documents (CDA), clinical notes, scanned paper, and non-patient specific documents like policy text.

PSI use case

non-patient documents like user’s “Terms & Conditions” for a site, bot or application

FHIR required properties

status: current | superseded | entered-in-error
content:
content/attachment:

PSI required properties*

masterIdentifier: system & value

docStatus: preliminary | final | amended | entered-in-error
type: LOINC code

category: LOINC code

date: timestamp for ‘valid from’

author: organization

custodian:

related to: // In the future, for replaces of the policy

description: xxxx

content: xxx

Extensions

Implemented: none

Under consideration: DocumentVersion version X.Y - Aug 2022

Sample payload

(minimum set)

Code Block
languagejson
{
  "resourceType": "DocumentReference",
  "masterIdentifier": {
    "system": "urn:ietf:rfc:3986",
    "value": "urn:oid:privacy-KN-2005-8-25"
  },
  "status": "current",
  "docStatus": "final",
  "type": {
    "coding": [
      {
        "system": "http://loinc.org",
        "code": "59284-0",
        "display": "Consent Document"
      }
    ]
  },
  "category": [
    {
      "coding": [
      {
        "system": "http://loinc.org",
        "code": "57017-6",
        "display": "Privacy policy Organization Document"
      }
      ]
    }
  ],

  "date": "2005-12-24T09:43:41+11:00",
  "author": [
    {
      "reference": "Organization/PSI"
    }
  ],
  
  "custodian":{
      "reference": "Organization/PSI"
    },

  // In the future, for replaces of the policy
  "relatesTo": [
    {
      "code": "appends",
      "target": {
        "reference": "DocumentReference/example"
      }
    }
  ],
  "description": "XXXX YYYY ZZZZ",

  "content": [
    {
      "attachment": {
        "contentType": "application/pdf",
        "language": "en",
        "url": "http://example.org/privacy.pdf",
        "size": 3654,
        "hash": "2jmj7l5rSw0yVb/vlWAYkK/YBwk=",
        "title": "Physical",
        "creation": "2005-12-24T09:35:00+11:00"
      }
    }
  ]
}

*in addition to countryISO & *projectID* tags, which are required by all resources.

Notes for DocumentResource FHIR resource, per property

Property

Required by PSI?

Notes

PSI tags

Status
colourGreen
titleYes
[psi/fhir]

Country ISO-3 code

Project Code

PENDING: implementation of this property

Status
colourYellow
titleoptional
[psi/fhir]